Sign in
Nodes

List all nodes

Returns all registered nodes (local and remote).

get/api/nodes

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

Changed in 2 of the 36 revisions of this API.24

  • d58cf9d6195b2See the full diff
    • ○

      removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 401

      response-property-enum-value-removed

    • ○

      removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 500

      response-property-enum-value-removed

  • 7464894ea58222See the full diff
    • ●

      added the new PAID_REQUIRED enum value to the code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new PAID_REQUIRED enum value to the code response property for the response status 500

      response-property-enum-value-added

    • ○

      removed the PRO_REQUIRED enum value from the code response property for the response status 401

      response-property-enum-value-removed

    • ○

      removed the PRO_REQUIRED enum value from the code response property for the response status 500

      response-property-enum-value-removed