KŽ´q Controller REST API | Datasance PoT Documentation
Skip to main content
Version: v3.8.0

Controller REST API

All public HTTP routes live under /api/v3/ on the Controller listener (default port 51121). Interactive exec and log streaming use WebSocket paths under the same prefix.

Browse the full OpenAPI spec on this site: API reference.

Greenfield release: v3.8.0

Controller v3.8.0 uses a new database schema. Do not point a v3.8 Controller at a v3.7 database. See Migrating to v3.8.0.

Authentication​

Browser login for EdgeOps Console uses the OAuth BFF:

GET /api/v3/user/oauth/authorize

Automation and potctl use Bearer tokens from your OIDC provider. In embedded mode the issuer is at {CONTROLLER_PUBLIC_URL}/oidc. See Embedded OIDC and Configuration.

Legacy browser POST /user/login and Keycloak-specific routes are removed.

Terminology changes (v3.7 → v3.8)​

v3.7v3.8
/api/v3/flow/*/api/v3/application/*
RBAC resource flowsapplications
GET /api/v3/fog-typesGET /api/v3/architectures/ (public)
Microservice create flowId query paramapplication string in JSON body
Catalog x86Image / armImageimages[] with { containerImage, archId } (up to 4 arches)
fogType / fogTypeId on agentsarch / archId

Error codes follow the same rename: INVALID_FLOW_* → INVALID_APPLICATION_*.

Architectures​

GET /api/v3/architectures/ returns supported CPU architectures:

archIdArchitecture
0auto
1amd64
2arm64
3riscv64
4arm (32-bit)

Catalog entries and microservices must declare images per archId. A microservice runtime must appear in the target agent's availableRuntimes.

Applications and microservices​

Application CRUD uses /api/v3/application/*. Example create body fields include name, description, and NATS rule references where applicable.

Microservice create/update:

  • Pass application (application name) in the body. The flowId query parameter is removed.
  • Use images[] instead of single-arch image fields.
  • User-supplied serviceAccount volume mappings are stripped on write; the Controller injects the canonical binding.

System microservice controller lives in application system-{agentName}. User delete returns 403; user PATCH returns 400.

Edgelet node (field agent) API​

Edgelet talks to Controller over HTTPS. Notable v3.8 paths:

MethodPathPurpose
GET/api/v3/agent/changesPoll config and workload changes
GET/api/v3/agent/exec/sessionsDiscover pending exec sessions
GET/api/v3/agent/logs/sessionsDiscover pending log sessions
POST/api/v3/agent/controller/registerRegister local ControlPlane controller workload (system fogs)
GET/api/v3/agent/versionPull agent/Edgelet version (refreshes provision key)

Agent config field renames: dockerUrl → containerEngineUrl, dockerPruningFrequency → pruningFrequency, fogType → arch.

WebSocket exec and logs​

REST POST/DELETE .../exec on microservices is removed. Open sessions over WebSocket only.

RoleExec attach path
User / ConsoleWS /api/v3/microservices/exec/:uuid (or .../system/exec/:uuid)
Edgelet field agentWS /api/v3/agent/exec/microservice/:microserviceUuid/:sessionId

Up to 5 concurrent exec sessions per microservice. Each session has its own sessionId and lifecycle. See Edgelet exec sessions.

Log streaming follows the same multi-session model with separate user and agent WebSocket paths.

Platform reconcile (v3.8)​

MethodPathPurpose
GET/api/v3/iofog/{uuid}Optional platformStatus (phase, generation, lastError)
POST/api/v3/iofog/{uuid}/reconcileManual retry after failed fog platform reconcile
POST/api/v3/services/{name}/reconcileManual retry for service platform reconcile

Removed APIs​

Do not call these on Controller v3.8:

  • All /api/v3/flow/* routes
  • EdgeResource CRUD and RBAC
  • Diagnostics, strace, and image snapshot / download endpoints
  • Microservice REST exec (POST/DELETE .../exec)
  • Legacy agent exec WebSocket without sessionId in the path
Group 3See anything wrong with the document? Help us improve it!

Edit this page on GitHub!

ÿÿÿÿ