Skip to content

API Reference

The Core API (server-core) exposes REST endpoints for managing all domain entities. Each service also generates Swagger/OpenAPI documentation when running.

Base URL

http://localhost:4000

Authentication

All endpoints (except health checks) require authentication via Authup. Include a Bearer token in the Authorization header:

Authorization: Bearer <token>

Core Entities

Analyses

MethodEndpointDescription
GET/analysesList analyses
GET/analyses/:idGet analysis by ID
POST/analysesCreate analysis
PUT/analyses/:idUpdate analysis
DELETE/analyses/:idDelete analysis

Projects

MethodEndpointDescription
GET/projectsList projects
GET/projects/:idGet project by ID
POST/projectsCreate project
PUT/projects/:idUpdate project
DELETE/projects/:idDelete project

Nodes

MethodEndpointDescription
GET/nodesList nodes
GET/nodes/:idGet node by ID
POST/nodesCreate node
PUT/nodes/:idUpdate node
DELETE/nodes/:idDelete node

Registries

MethodEndpointDescription
GET/registriesList registries
GET/registries/:idGet registry by ID
POST/registriesCreate registry
PUT/registries/:idUpdate registry
DELETE/registries/:idDelete registry

Storage Service

Base URL: http://localhost:4001

Buckets

MethodEndpointDescription
GET/bucketsList buckets
GET/buckets/:idGet bucket by ID
POST/bucketsCreate bucket
DELETE/buckets/:idDelete bucket

Bucket Files

MethodEndpointDescription
GET/bucket-filesList bucket files
POST/bucket-filesUpload file to bucket
GET/bucket-files/:id/streamStream file contents

Swagger Documentation

Each service generates OpenAPI documentation at runtime. When a service is running in development mode, visit:

  • Core API: http://localhost:4000/docs
  • Storage: http://localhost:4001/docs
  • Telemetry: http://localhost:4002/docs

Released under the Apache-2.0 License.