Nodes

Register a new node

Adds a new local or remote node. Only one local node is allowed per instance; attempting to create a second local node returns 409. Remote nodes require an API URL pointing to another Sencho instance and an API token for authentication. Requires node:manage permission. Node type is immutable after creation.

Note: API tokens cannot manage nodes.

post/api/nodes

Request body

namestring required

type'local' | 'remote' required

compose_dirstring

Base directory for Compose stacks (defaults to /app/compose).

is_defaultboolean

Set as the default node.

api_urlstring

Remote Sencho instance URL (required for remote nodes).

api_tokenstring

API token for authenticating with the remote Sencho instance.

Example request

{
  "name": "production-server",
  "api_url": "https://sencho.example.com:1852"
}

Response

Node created.

successboolean required

idinteger required

New node ID.

warningstring

Warning if the remote URL uses plain HTTP.

Changes

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

Jun 4, 2026d58cf9d6195b4See the full diff
- ○
  removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 403
  response-property-enum-value-removed
- ○
  removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 409
  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
Apr 5, 20267464894ea58244See the full diff
- ●
  added the new PAID_REQUIRED enum value to the code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new PAID_REQUIRED enum value to the code response property for the response status 403
  response-property-enum-value-added
- ●
  added the new PAID_REQUIRED enum value to the code response property for the response status 409
  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 400
  response-property-enum-value-removed
- ○
  removed the PRO_REQUIRED enum value from the code response property for the response status 403
  response-property-enum-value-removed
- ○
  removed the PRO_REQUIRED enum value from the code response property for the response status 409
  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

Full history