API Docs

AxiNode APIs

REST `/api/v1` for UI/CLI, and gRPC `axinode.agent.v1` for agents. ProblemDetails errors carry correlation IDs to align audit and telemetry.

Authentication

  • Users: login → JWT access/refresh; bearer Authorization header.
  • API tokens: per user/tenant; stored hashed; bearer Authorization header.
  • Agents: outbound mTLS or agent JWT derived from agent identity.

Common REST endpoints

GET /api/v1/servers — List servers (filter by env/tag/status)

POST /api/v1/servers/{id}/commands — Enqueue signed command for a server/group

GET /api/v1/commands/{id} — Get command status + execution result

POST /api/v1/agents/bootstrap-tokens — Create bootstrap token for agent enrollment

Example: create command

POST /api/v1/servers/{id}/commands
{
  "type": "RestartService",
  "payload": { "serviceName": "W3SVC" },
  "timeoutSeconds": 120
}

Response includes commandId and correlationId for audit.

ProblemDetails (error)

{
  "type": "https://api.axinode.com/errors/command-policy",
  "title": "Policy validation failed",
  "status": 403,
  "correlationId": "cmd-01h9p...",
  "detail": "Policy AllowRestart denied for target group iis-prod"
}

Use correlationId to join audit/telemetry logs.

Agent gRPC (axinode.agent.v1)

Agents use outbound mTLS gRPC for registration, heartbeats, command pull, result reporting, and telemetry streaming.

Related docs