STstudio-saelix
Nodes

List all nodes

Returns all registered nodes (local and remote).

get/api/nodes

Request

  • Base URL
    https://localhost:1852
  • URL
    https://localhost:1852/api/nodes
  • Auth
    HTTP bearer

Response

Array of node objects.

idinteger required
namestring required
type'local' | 'remote' required
compose_dirstring required

Base directory for Docker Compose stacks on this node.

is_default0 | 1 required

Whether this is the default node (1 = true).

api_urlstring

Remote node API URL (only for remote nodes).

api_tokenstring

Redacted API token for remote node authentication.

created_atinteger required

Unix timestamp (seconds).

Changes