Sign in
Nodes

Register a new node

Adds a new local or remote node. Remote nodes require an API URL pointing to another Sencho instance and an API token for authentication. Requires node:manage permission.

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:3000"
}

Response

Node created.

successboolean required
idinteger required

New node ID.

warningstring

Warning if the remote URL uses plain HTTP.

Changes