STstudio-saelix
Nodes

Register a new node

Changed on

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

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

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

  • d58cf9d6195bRevision changes
    • info

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

    • info

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

    • info

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

    • info

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

  • 7464894ea582Revision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

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

    • info

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

    • info

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

    • info

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