RSX · API · Reference

node v1

Control plane for RSX-managed compute nodes: registration, desired state, and reported status.

openapi.json

Current

Base URL: https://api.rsx.group/node/v1
Self-grantable scopes: None. Every endpoint here needs a key issued by a platform admin.
Machine readable: openapi.json

admin

14 operations under /node/v1/admin.

GET/node/v1/admin/nodes/list

Every node, and what each last reported

Scope: node:admin:nodes:list Admin-issued keys only.

Query parameters

Query parameters of adminListNodes
Parameter	Type	Description
cursor	string
limit	integer	1 to 100 · default 20

cursor
Type
string
Description
limit
Type
integer
Description
1 to 100 · default 20

Response 200Nodes

Response of adminListNodes
Field	Type	Description
datarequired	array of NodeSummary
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
agent	NodeAgent
sealing	NodeSealing
platformrequired	NodePlatform
runtimerequired	NodeRuntime
capacityrequired	NodeCapacity
featuresrequired	NodeFeatures
registeredAtrequired	string, date-time
lastSeenAtrequired	string, date-time
generationrequired	integer	at least 0
statusrequired	NodeStatus
metarequired	object
cursorrequired	string, or null

datarequired
Type
array of NodeSummary
Description
nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
agent
Type
NodeAgent
Description
sealing
Type
NodeSealing
Description
platformrequired
Type
NodePlatform
Description
runtimerequired
Type
NodeRuntime
Description
capacityrequired
Type
NodeCapacity
Description
featuresrequired
Type
NodeFeatures
Description
registeredAtrequired
Type
string, date-time
Description
lastSeenAtrequired
Type
string, date-time
Description
generationrequired
Type
integer
Description
at least 0
statusrequired
Type
NodeStatus
Description
metarequired
Type
object
Description
cursorrequired
Type
string, or null
Description

Example

curl

curl "https://api.rsx.group/node/v1/admin/nodes/list" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": [
    {
      "nodeId": "macbook-dev-01",
      "agent": {
        "version": "0.1.0",
        "commit": "5036308f9859",
        "builtAt": "2026-08-30T23:30:34Z"
      },
      "sealing": {
        "algorithm": "x25519-hkdf-sha256-aes256gcm",
        "publicKey": "string"
      },
      "platform": {
        "os": "macos",
        "architecture": "x86_64",
        "kernel": "6.1.0-25-amd64"
      },
      "runtime": {
        "docker": true,
        "version": "29.6.2"
      },
      "capacity": {
        "memoryBytes": 8589934592,
        "cpus": 4
      },
      "features": {
        "build": true,
        "cloudflareTunnel": true,
        "hostMetrics": true
      },
      "registeredAt": "2026-08-27T09:14:02Z",
      "lastSeenAt": "2026-08-27T09:41:55Z",
      "generation": 7,
      "status": {
        "nodeId": "macbook-dev-01",
        "generation": 7,
        "status": "HEALTHY",
        "docker": "Docker 29.6.2 on linux/x86_64, 7.4 GiB memory, 12 CPUs",
        "workloads": [
          null
        ],
        "host": null,
        "jobs": [
          null
        ],
        "reportedAt": "2026-08-27T09:41:55Z"
      }
    }
  ],
  "meta": {
    "cursor": "string"
  }
}

GET/node/v1/admin/nodes/get

One node: what it is, what it was told, and what it reports

Scope: node:admin:nodes:get Admin-issued keys only.

Query parameters

Query parameters of adminGetNode
Parameter	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$

Response 200The node

Response of adminGetNode
Field	Type	Description
datarequired	NodeDetail
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
agent	NodeAgent
sealing	NodeSealing
platformrequired	NodePlatform
runtimerequired	NodeRuntime
capacityrequired	NodeCapacity
featuresrequired	NodeFeatures
registeredAtrequired	string, date-time
lastSeenAtrequired	string, date-time
generationrequired	integer	at least 0
statusrequired	NodeStatus
desiredrequired	string, or null

datarequired
Type
NodeDetail
Description
nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
agent
Type
NodeAgent
Description
sealing
Type
NodeSealing
Description
platformrequired
Type
NodePlatform
Description
runtimerequired
Type
NodeRuntime
Description
capacityrequired
Type
NodeCapacity
Description
featuresrequired
Type
NodeFeatures
Description
registeredAtrequired
Type
string, date-time
Description
lastSeenAtrequired
Type
string, date-time
Description
generationrequired
Type
integer
Description
at least 0
statusrequired
Type
NodeStatus
Description
desiredrequired
Type
string, or null
Description

Example

curl

curl "https://api.rsx.group/node/v1/admin/nodes/get?nodeId=macbook-dev-01" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": {
    "nodeId": "macbook-dev-01",
    "agent": {
      "version": "0.1.0",
      "commit": "5036308f9859",
      "builtAt": "2026-08-30T23:30:34Z"
    },
    "sealing": {
      "algorithm": "x25519-hkdf-sha256-aes256gcm",
      "publicKey": "string"
    },
    "platform": {
      "os": "macos",
      "architecture": "x86_64",
      "kernel": "6.1.0-25-amd64"
    },
    "runtime": {
      "docker": true,
      "version": "29.6.2"
    },
    "capacity": {
      "memoryBytes": 8589934592,
      "cpus": 4
    },
    "features": {
      "build": true,
      "cloudflareTunnel": true,
      "hostMetrics": true
    },
    "registeredAt": "2026-08-27T09:14:02Z",
    "lastSeenAt": "2026-08-27T09:41:55Z",
    "generation": 7,
    "status": {
      "nodeId": "macbook-dev-01",
      "generation": 7,
      "status": "HEALTHY",
      "docker": "Docker 29.6.2 on linux/x86_64, 7.4 GiB memory, 12 CPUs",
      "workloads": [
        null
      ],
      "host": {
        "cpuPercent": null,
        "memory": null,
        "disks": null
      },
      "jobs": [
        null
      ],
      "reportedAt": "2026-08-27T09:41:55Z"
    },
    "desired": "{\"generation\":7,\"workloads\":[]}"
  }
}

POST/node/v1/admin/desired/update

Set what a node should be running

Scope: node:admin:desired:update Admin-issued keys only.

Request bodyapplication/json

Request body of adminUpdateNodeDesiredState
Field	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
workloadsrequired	array of object
idrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
state	string	one of "running", "stopped" · default "running"
sourcerequired	object
repository	string
revisionrequired	string	1 to 64 characters
build	string	one of "registry", "local" · default "registry"
registry	NodeWorkloadRegistryRef
imagerequired	string
env	map of string	default {}
{key}	string	up to 4096 characters
volumes	array of NodeWorkloadVolume	default []
resources	NodeWorkloadResources	default {}
restart	string	one of "no", "always", "unless-stopped" · default "unless-stopped"
health	NodeWorkloadHealth	default {"type":"process","settleSeconds":5}
command	array of string
diagnostics	object
probes	map of array of string	default {}
{key}	array of string	1 to 32 items
ingress	NodeWorkloadIngress
jobs	array of object	default []
idrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
sourcerequired	object
repository	string
revisionrequired	string	1 to 64 characters
build	string	one of "registry", "local" · default "registry"
registry	NodeWorkloadRegistryRef
imagerequired	string
commandrequired	array of string	1 to 64 items
env	map of string	default {}
{key}	string	up to 4096 characters
volumes	array of NodeWorkloadVolume	default []
resources	NodeWorkloadResources	default {}
timeoutSeconds	integer	1 to 86400 · default 3600
retainRuns	integer	1 to 20 · default 5
trigger	NodeJobTrigger

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
workloadsrequired
Type
array of object
Description
idrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
state
Type
string
Description
one of "running", "stopped" · default "running"
sourcerequired
Type
object
Description
repository
Type
string
Description
revisionrequired
Type
string
Description
1 to 64 characters
build
Type
string
Description
one of "registry", "local" · default "registry"
registry
Type
NodeWorkloadRegistryRef
Description
imagerequired
Type
string
Description
env
Type
map of string
Description
default {}
{key}
Type
string
Description
up to 4096 characters
volumes
Type
array of NodeWorkloadVolume
Description
default []
resources
Type
NodeWorkloadResources
Description
default {}
restart
Type
string
Description
one of "no", "always", "unless-stopped" · default "unless-stopped"
health
Type
NodeWorkloadHealth
Description
default {"type":"process","settleSeconds":5}
command
Type
array of string
Description
diagnostics
Type
object
Description
probes
Type
map of array of string
Description
default {}
{key}
Type
array of string
Description
1 to 32 items
ingress
Type
NodeWorkloadIngress
Description
jobs
Type
array of object
Description
default []
idrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
sourcerequired
Type
object
Description
repository
Type
string
Description
revisionrequired
Type
string
Description
1 to 64 characters
build
Type
string
Description
one of "registry", "local" · default "registry"
registry
Type
NodeWorkloadRegistryRef
Description
imagerequired
Type
string
Description
commandrequired
Type
array of string
Description
1 to 64 items
env
Type
map of string
Description
default {}
{key}
Type
string
Description
up to 4096 characters
volumes
Type
array of NodeWorkloadVolume
Description
default []
resources
Type
NodeWorkloadResources
Description
default {}
timeoutSeconds
Type
integer
Description
1 to 86400 · default 3600
retainRuns
Type
integer
Description
1 to 20 · default 5
trigger
Type
NodeJobTrigger
Description

Response 200The new desired state, with the generation it was given

Response of adminUpdateNodeDesiredState
Field	Type	Description
datarequired	object
generationrequired	integer	at least 0
workloadsrequired	array of NodeWorkload
jobsrequired	array of NodeJob

datarequired
Type
object
Description
generationrequired
Type
integer
Description
at least 0
workloadsrequired
Type
array of NodeWorkload
Description
jobsrequired
Type
array of NodeJob
Description

Example

curl

curl -X POST https://api.rsx.group/node/v1/admin/desired/update \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "nodeId": "macbook-dev-01",
  "workloads": [
    {
      "id": "roxy",
      "state": "running",
      "source": {
        "repository": "git@github.com:RSXGroup/roxy.git",
        "revision": "7f31c2a",
        "build": "registry",
        "registry": {
          "package": null,
          "version": null
        },
        "image": "ghcr.io/rsxgroup/roxy@sha256:28bd5fe8b56d1bd048e5babf5b10710ebe0bae67db86916198a6eec434943f8b"
      },
      "env": {},
      "volumes": [],
      "resources": {},
      "restart": "unless-stopped",
      "health": {
        "type": "process",
        "settleSeconds": 5
      },
      "command": [
        "string"
      ],
      "diagnostics": {
        "probes": {}
      },
      "ingress": {
        "port": 3000,
        "hostnames": [
          "logs.rsx.group"
        ],
        "access": true
      }
    }
  ],
  "jobs": []
}'

200 response

{
  "data": {
    "generation": 1,
    "workloads": [
      {
        "id": "roxy",
        "state": "running",
        "source": {
          "repository": "git@github.com:RSXGroup/roxy.git",
          "revision": "7f31c2a",
          "build": "registry",
          "registry": {
            "package": null,
            "version": null
          },
          "image": "ghcr.io/rsxgroup/roxy@sha256:28bd5fe8b56d1bd048e5babf5b10710ebe0bae67db86916198a6eec434943f8b"
        },
        "env": {},
        "volumes": [],
        "resources": {},
        "restart": "unless-stopped",
        "health": {
          "type": "process",
          "settleSeconds": 5
        },
        "command": [
          "string"
        ],
        "diagnostics": {
          "probes": {}
        },
        "ingress": {
          "port": 3000,
          "hostnames": [
            "logs.rsx.group"
          ],
          "access": true
        }
      }
    ],
    "jobs": [
      {
        "id": "roxy-migrate",
        "source": {
          "repository": "git@github.com:RSXGroup/roxy.git",
          "revision": "7f31c2a",
          "build": "registry",
          "registry": {
            "package": null,
            "version": null
          },
          "image": "ghcr.io/rsxgroup/roxy@sha256:28bd5fe8b56d1bd048e5babf5b10710ebe0bae67db86916198a6eec434943f8b"
        },
        "command": [
          "node",
          "scripts/migrate.js",
          "--to",
          "latest"
        ],
        "env": {},
        "volumes": [],
        "resources": {},
        "timeoutSeconds": 1800,
        "retainRuns": 5,
        "trigger": {
          "github": {
            "repository": "RSXGroup/site",
            "refs": [
              null
            ]
          }
        }
      }
    ]
  }
}

POST/node/v1/admin/commands/add

Ask a node to do something

Scope: node:admin:commands:add Admin-issued keys only.
Idempotency: Requires an Idempotency-Key header. Reusing the key within 24 hours returns the original response instead of creating a second record.

Request bodyapplication/json

IssueNodeCommand

Response 200The command, waiting to be collected

Response of adminIssueNodeCommand
Field	Type	Description
datarequired	NodeCommandRecord
idrequired	string
kindrequired	string	one of "reconcile", "restart", "redeploy", "logs", "diagnose", "secret", "update", "reboot", "shutdown", "run"
arguments	map of any	default {}
{key}	any
issuedAtrequired	string, date-time
issuedByrequired	string
staterequired	string	one of "pending", "done", "failed"
ackedAtrequired	string, date-time, or null
detailrequired	string, or null
outputrequired	string, or null

datarequired
Type
NodeCommandRecord
Description
idrequired
Type
string
Description
kindrequired
Type
string
Description
one of "reconcile", "restart", "redeploy", "logs", "diagnose", "secret", "update", "reboot", "shutdown", "run"
arguments
Type
map of any
Description
default {}
{key}
Type
any
Description
issuedAtrequired
Type
string, date-time
Description
issuedByrequired
Type
string
Description
staterequired
Type
string
Description
one of "pending", "done", "failed"
ackedAtrequired
Type
string, date-time, or null
Description
detailrequired
Type
string, or null
Description
outputrequired
Type
string, or null
Description

Example

curl

curl -X POST https://api.rsx.group/node/v1/admin/commands/add \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Idempotency-Key: 5b8f2d1a-0c7e-4b1f-9a6d-3e2f1c0b9a8d" \
  -H "Content-Type: application/json" \
  -d '{
  "nodeId": "macbook-dev-01",
  "kind": "reconcile"
}'

200 response

{
  "data": {
    "id": "01JD3M4K5N6P7Q8R9S0T1U2V3W",
    "kind": "restart",
    "arguments": {},
    "issuedAt": "2026-08-31T09:14:02Z",
    "issuedBy": "paige@rsx.group",
    "state": "pending",
    "ackedAt": "2026-10-10T12:00:00.000Z",
    "detail": "string",
    "output": "string"
  }
}

POST/node/v1/admin/tunnel/send

Send a node its tunnel token, sealed to its key

Scope: node:admin:tunnel:send Admin-issued keys only.

Request bodyapplication/json

Request body of adminSendNodeTunnelToken
Field	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$

Response 200The secret command, waiting to be collected

Response of adminSendNodeTunnelToken
Field	Type	Description
datarequired	NodeCommandRecord
idrequired	string
kindrequired	string	one of "reconcile", "restart", "redeploy", "logs", "diagnose", "secret", "update", "reboot", "shutdown", "run"
arguments	map of any	default {}
{key}	any
issuedAtrequired	string, date-time
issuedByrequired	string
staterequired	string	one of "pending", "done", "failed"
ackedAtrequired	string, date-time, or null
detailrequired	string, or null
outputrequired	string, or null

datarequired
Type
NodeCommandRecord
Description
idrequired
Type
string
Description
kindrequired
Type
string
Description
one of "reconcile", "restart", "redeploy", "logs", "diagnose", "secret", "update", "reboot", "shutdown", "run"
arguments
Type
map of any
Description
default {}
{key}
Type
any
Description
issuedAtrequired
Type
string, date-time
Description
issuedByrequired
Type
string
Description
staterequired
Type
string
Description
one of "pending", "done", "failed"
ackedAtrequired
Type
string, date-time, or null
Description
detailrequired
Type
string, or null
Description
outputrequired
Type
string, or null
Description

Example

curl

curl -X POST https://api.rsx.group/node/v1/admin/tunnel/send \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "nodeId": "macbook-dev-01"
}'

200 response

{
  "data": {
    "id": "01JD3M4K5N6P7Q8R9S0T1U2V3W",
    "kind": "restart",
    "arguments": {},
    "issuedAt": "2026-08-31T09:14:02Z",
    "issuedBy": "paige@rsx.group",
    "state": "pending",
    "ackedAt": "2026-10-10T12:00:00.000Z",
    "detail": "string",
    "output": "string"
  }
}

GET/node/v1/admin/tunnel/get

Reveal a node's tunnel token, to seal on it

Scope: node:admin:tunnel:get Admin-issued keys only.

Query parameters

Query parameters of adminGetNodeTunnelToken
Parameter	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$

Response 200The token. Seal it with `rsx-node tunnel token` and do not keep it.

Response of adminGetNodeTunnelToken
Field	Type	Description
datarequired	NodeTunnelToken
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
tunnelIdrequired	string
tokenrequired	string

datarequired
Type
NodeTunnelToken
Description
nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
tunnelIdrequired
Type
string
Description
tokenrequired
Type
string
Description

Example

curl

curl "https://api.rsx.group/node/v1/admin/tunnel/get?nodeId=macbook-dev-01" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": {
    "nodeId": "macbook-dev-01",
    "tunnelId": "string",
    "token": "string"
  }
}

GET/node/v1/admin/commands/list

What has been asked of a node, and what came of it

Scope: node:admin:commands:list Admin-issued keys only.

Query parameters

Query parameters of adminListNodeCommands
Parameter	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
limit	integer	1 to 100 · default 20

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
limit
Type
integer
Description
1 to 100 · default 20

Response 200Recent commands, newest first

Response of adminListNodeCommands
Field	Type	Description
datarequired	array of NodeCommandRecord
idrequired	string
kindrequired	string	one of "reconcile", "restart", "redeploy", "logs", "diagnose", "secret", "update", "reboot", "shutdown", "run"
arguments	map of any	default {}
{key}	any
issuedAtrequired	string, date-time
issuedByrequired	string
staterequired	string	one of "pending", "done", "failed"
ackedAtrequired	string, date-time, or null
detailrequired	string, or null
outputrequired	string, or null

datarequired
Type
array of NodeCommandRecord
Description
idrequired
Type
string
Description
kindrequired
Type
string
Description
one of "reconcile", "restart", "redeploy", "logs", "diagnose", "secret", "update", "reboot", "shutdown", "run"
arguments
Type
map of any
Description
default {}
{key}
Type
any
Description
issuedAtrequired
Type
string, date-time
Description
issuedByrequired
Type
string
Description
staterequired
Type
string
Description
one of "pending", "done", "failed"
ackedAtrequired
Type
string, date-time, or null
Description
detailrequired
Type
string, or null
Description
outputrequired
Type
string, or null
Description

Example

curl

curl "https://api.rsx.group/node/v1/admin/commands/list?nodeId=macbook-dev-01" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": [
    {
      "id": "01JD3M4K5N6P7Q8R9S0T1U2V3W",
      "kind": "restart",
      "arguments": {},
      "issuedAt": "2026-08-31T09:14:02Z",
      "issuedBy": "paige@rsx.group",
      "state": "pending",
      "ackedAt": "2026-10-10T12:00:00.000Z",
      "detail": "string",
      "output": "string"
    }
  ]
}

GET/node/v1/admin/runs/list

The runs of a node's jobs, and how each ended

Scope: node:admin:runs:list Admin-issued keys only.

Query parameters

Query parameters of adminListNodeRuns
Parameter	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
jobId	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
limit	integer	1 to 200 · default 20

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
jobId
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
limit
Type
integer
Description
1 to 200 · default 20

Response 200Runs, newest first by when this service first saw each

Response of adminListNodeRuns
Field	Type	Description
datarequired	array of NodeRunRecord
runIdrequired	string	1 to 64 characters
revisionrequired	string	1 to 128 characters
staterequired	string	one of "running", "succeeded", "failed", "timed-out"
exitCoderequired	integer, or null
startedAtrequired	string, date-time, or null
finishedAtrequired	string, date-time, or null
detailrequired	string	up to 1024 characters
jobIdrequired	string	1 to 63 characters
recordedAtrequired	string, date-time

datarequired
Type
array of NodeRunRecord
Description
runIdrequired
Type
string
Description
1 to 64 characters
revisionrequired
Type
string
Description
1 to 128 characters
staterequired
Type
string
Description
one of "running", "succeeded", "failed", "timed-out"
exitCoderequired
Type
integer, or null
Description
startedAtrequired
Type
string, date-time, or null
Description
finishedAtrequired
Type
string, date-time, or null
Description
detailrequired
Type
string
Description
up to 1024 characters
jobIdrequired
Type
string
Description
1 to 63 characters
recordedAtrequired
Type
string, date-time
Description

Example

curl

curl "https://api.rsx.group/node/v1/admin/runs/list?nodeId=macbook-dev-01" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": [
    {
      "runId": "01JD3M4K5N6P7Q8R9S0T1U2V3W",
      "revision": "7f31c2a",
      "state": "succeeded",
      "exitCode": 0,
      "startedAt": "2026-10-09T09:14:05Z",
      "finishedAt": "2026-10-09T09:14:41Z",
      "detail": "exited 0 after 36s",
      "jobId": "roxy-migrate",
      "recordedAt": "2026-10-09T09:14:07Z"
    }
  ]
}

POST/node/v1/admin/triggers/github

Start the runs a GitHub push triggers

Called by services/webhooks/v1 for every authenticated push. Matching jobs have the pushed commit written into their revision and RSX_COMMIT, RSX_REF and RSX_REPOSITORY, and are run once the node reports acting on that generation. A delivery id already seen does nothing.

Scope: node:admin:triggers:github Admin-issued keys only.

Request bodyapplication/json

Request body of adminReceiveGithubPush
Field	Type	Description
deliveryIdrequired	string	1 to 128 characters
repositoryrequired	string	1 to 255 characters
refrequired	string	1 to 1024 characters
commitrequired	string	1 to 128 characters
pusher	string	up to 128 characters · default ""

deliveryIdrequired
Type
string
Description
1 to 128 characters
repositoryrequired
Type
string
Description
1 to 255 characters
refrequired
Type
string
Description
1 to 1024 characters
commitrequired
Type
string
Description
1 to 128 characters
pusher
Type
string
Description
up to 128 characters · default ""

Response 200What the push did to each matching job

Response of adminReceiveGithubPush
Field	Type	Description
datarequired	NodeTriggerResult
dedupedrequired	boolean
ignoredrequired	string, or null
matchedrequired	array of NodeTriggerMatch

datarequired
Type
NodeTriggerResult
Description
dedupedrequired
Type
boolean
Description
ignoredrequired
Type
string, or null
Description
matchedrequired
Type
array of NodeTriggerMatch
Description

Example

curl

curl -X POST https://api.rsx.group/node/v1/admin/triggers/github \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "deliveryId": "string",
  "repository": "RSXGroup/site",
  "ref": "refs/heads/main",
  "commit": "7f31c2a9d4e8b1f0c3a5d7e9f2b4c6a8d0e1f3a5",
  "pusher": ""
}'

200 response

{
  "data": {
    "deduped": true,
    "ignored": "string",
    "matched": [
      {
        "nodeId": "string",
        "jobId": "string",
        "outcome": "queued",
        "detail": "string"
      }
    ]
  }
}

GET/node/v1/admin/triggers/list

Pushes waiting to become runs on a node

Scope: node:admin:triggers:list Admin-issued keys only.

Query parameters

Query parameters of adminListNodePendingTriggers
Parameter	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$

Response 200One per job at most

Response of adminListNodePendingTriggers
Field	Type	Description
datarequired	array of NodePendingTrigger
nodeIdrequired	string
jobIdrequired	string
commitrequired	string
refrequired	string
generationrequired	integer
actorrequired	string
pusherrequired	string
queuedAtrequired	string, date-time
commandIdrequired	string, or null

datarequired
Type
array of NodePendingTrigger
Description
nodeIdrequired
Type
string
Description
jobIdrequired
Type
string
Description
commitrequired
Type
string
Description
refrequired
Type
string
Description
generationrequired
Type
integer
Description
actorrequired
Type
string
Description
pusherrequired
Type
string
Description
queuedAtrequired
Type
string, date-time
Description
commandIdrequired
Type
string, or null
Description

Example

curl

curl "https://api.rsx.group/node/v1/admin/triggers/list?nodeId=macbook-dev-01" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": [
    {
      "nodeId": "string",
      "jobId": "string",
      "commit": "string",
      "ref": "string",
      "generation": 1,
      "actor": "string",
      "pusher": "string",
      "queuedAt": "2026-10-10T12:00:00.000Z",
      "commandId": "string"
    }
  ]
}

POST/node/v1/admin/triggers/discard

Drop a push that is waiting to become a run

Scope: node:admin:triggers:discard Admin-issued keys only.

Request bodyapplication/json

Request body of adminDiscardNodePendingTrigger
Field	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
jobIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
jobIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$

Response 200Whether there was one

Response of adminDiscardNodePendingTrigger
Field	Type	Description
datarequired	object
discardedrequired	boolean

datarequired
Type
object
Description
discardedrequired
Type
boolean
Description

Example

curl

curl -X POST https://api.rsx.group/node/v1/admin/triggers/discard \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "nodeId": "macbook-dev-01",
  "jobId": "macbook-dev-01"
}'

200 response

{
  "data": {
    "discarded": true
  }
}

GET/node/v1/admin/releases/list

Builds of the node that a node could be updated to

Scope: node:admin:releases:list Admin-issued keys only.

Query parameters

Query parameters of adminListNodeReleases
Parameter	Type	Description
limit	integer	1 to 30 · default 10

limit
Type
integer
Description
1 to 30 · default 10

Response 200Recent releases, newest first

Response of adminListNodeReleases
Field	Type	Description
datarequired	array of NodeRelease
tagrequired	string
namerequired	string
publishedAtrequired	string, or null
prereleaserequired	boolean
assetsrequired	array of NodeReleaseAsset

datarequired
Type
array of NodeRelease
Description
tagrequired
Type
string
Description
namerequired
Type
string
Description
publishedAtrequired
Type
string, or null
Description
prereleaserequired
Type
boolean
Description
assetsrequired
Type
array of NodeReleaseAsset
Description

Errors

Each is an RFC 7807 problem document whose type URL is a page in the error reference.

501This service has no GitHub credentials

Example

curl

curl "https://api.rsx.group/node/v1/admin/releases/list" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": [
    {
      "tag": "build-5036308f9859",
      "name": "string",
      "publishedAt": "string",
      "prerelease": true,
      "assets": [
        {
          "assetId": 1,
          "name": "rsx-node-x86_64-apple-darwin",
          "size": 1,
          "sha256": "string",
          "target": "x86_64-apple-darwin"
        }
      ]
    }
  ]
}

POST/node/v1/admin/commands/update

Ask a node to update itself to a published build

Scope: node:admin:commands:update Admin-issued keys only.

Request bodyapplication/json

Request body of adminUpdateNodeFromRelease
Field	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
version	string	1 to 128 characters
platform	string	1 to 64 characters
assetId	integer

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
version
Type
string
Description
1 to 128 characters
platform
Type
string
Description
1 to 64 characters
assetId
Type
integer
Description

Response 200The command, waiting to be collected

Response of adminUpdateNodeFromRelease
Field	Type	Description
datarequired	NodeCommandRecord
idrequired	string
kindrequired	string	one of "reconcile", "restart", "redeploy", "logs", "diagnose", "secret", "update", "reboot", "shutdown", "run"
arguments	map of any	default {}
{key}	any
issuedAtrequired	string, date-time
issuedByrequired	string
staterequired	string	one of "pending", "done", "failed"
ackedAtrequired	string, date-time, or null
detailrequired	string, or null
outputrequired	string, or null

datarequired
Type
NodeCommandRecord
Description
idrequired
Type
string
Description
kindrequired
Type
string
Description
one of "reconcile", "restart", "redeploy", "logs", "diagnose", "secret", "update", "reboot", "shutdown", "run"
arguments
Type
map of any
Description
default {}
{key}
Type
any
Description
issuedAtrequired
Type
string, date-time
Description
issuedByrequired
Type
string
Description
staterequired
Type
string
Description
one of "pending", "done", "failed"
ackedAtrequired
Type
string, date-time, or null
Description
detailrequired
Type
string, or null
Description
outputrequired
Type
string, or null
Description

Example

curl

curl -X POST https://api.rsx.group/node/v1/admin/commands/update \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "nodeId": "macbook-dev-01",
  "version": "build-7f31c2a",
  "platform": "x86_64-apple-darwin",
  "assetId": 284739201
}'

200 response

{
  "data": {
    "id": "01JD3M4K5N6P7Q8R9S0T1U2V3W",
    "kind": "restart",
    "arguments": {},
    "issuedAt": "2026-08-31T09:14:02Z",
    "issuedBy": "paige@rsx.group",
    "state": "pending",
    "ackedAt": "2026-10-10T12:00:00.000Z",
    "detail": "string",
    "output": "string"
  }
}

GET/node/v1/admin/audit/list

Who changed what a node runs, and who asked it to do something

Newest first. desired.updated is recorded whether it came from the dashboard or from an API key, so actor is an operator's name or a key id. A node's first registration is recorded; its heartbeats and status reports are not.

Scope: node:admin:audit:list Admin-issued keys only.

Query parameters

Query parameters of adminListNodeAudit
Parameter	Type	Description
targetType	string	one of "node"
targetId	string	up to 128 characters
actor	string	up to 320 characters
action	string	one of "node.registered", "desired.updated", "command.issued", "tunnel.token.revealed", "tunnel.token.sent", "job.triggered", "job.trigger.dropped"
offset	integer, or null	at least 0 · default 0
limit	integer	1 to 100 · default 50

targetType
Type
string
Description
one of "node"
targetId
Type
string
Description
up to 128 characters
actor
Type
string
Description
up to 320 characters
action
Type
string
Description
one of "node.registered", "desired.updated", "command.issued", "tunnel.token.revealed", "tunnel.token.sent", "job.triggered", "job.trigger.dropped"
offset
Type
integer, or null
Description
at least 0 · default 0
limit
Type
integer
Description
1 to 100 · default 50

Response 200Audit events

Response of adminListNodeAudit
Field	Type	Description
datarequired	array of NodeAuditEvent
idrequired	string
actorrequired	string
actionrequired	string	one of "node.registered", "desired.updated", "command.issued", "tunnel.token.revealed", "tunnel.token.sent", "job.triggered", "job.trigger.dropped"
targetTyperequired	string	one of "node"
targetIdrequired	string
targetLabelrequired	string, or null
atrequired	string, date-time
detailrequired	string, or null
metarequired	object
offsetrequired	integer
limitrequired	integer
morerequired	boolean

datarequired
Type
array of NodeAuditEvent
Description
idrequired
Type
string
Description
actorrequired
Type
string
Description
actionrequired
Type
string
Description
one of "node.registered", "desired.updated", "command.issued", "tunnel.token.revealed", "tunnel.token.sent", "job.triggered", "job.trigger.dropped"
targetTyperequired
Type
string
Description
one of "node"
targetIdrequired
Type
string
Description
targetLabelrequired
Type
string, or null
Description
atrequired
Type
string, date-time
Description
detailrequired
Type
string, or null
Description
metarequired
Type
object
Description
offsetrequired
Type
integer
Description
limitrequired
Type
integer
Description
morerequired
Type
boolean
Description

Example

curl

curl "https://api.rsx.group/node/v1/admin/audit/list" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": [
    {
      "id": "018f3b1c-9a2e-7c31-8f4d-2a6b5c7e9d12",
      "actor": "ops@rsx.group",
      "action": "node.registered",
      "targetType": "node",
      "targetId": "string",
      "targetLabel": "string",
      "at": "2026-09-12T10:16:30.000Z",
      "detail": "string"
    }
  ],
  "meta": {
    "offset": 1,
    "limit": 1,
    "more": true
  }
}

nodes

2 operations under /node/v1/nodes.

POST/node/v1/nodes/update

Register a node, or update what it reports about itself

Scope: node:nodes:update Admin-issued keys only.

Request bodyapplication/json

Request body of updateNode
Field	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
agent	NodeAgent
versionrequired	string	up to 32 characters
commitrequired	string	up to 64 characters
builtAtrequired	string	up to 32 characters
sealing	NodeSealing
algorithmrequired	string	one of "x25519-hkdf-sha256-aes256gcm"
publicKeyrequired	string	matches ^[A-Za-z0-9+/]{43}=$
platformrequired	NodePlatform
osrequired	string	at least 1 character
architecturerequired	string	at least 1 character
kernel	string	1 to 64 characters
runtimerequired	NodeRuntime
dockerrequired	boolean
versionrequired	string
capacityrequired	NodeCapacity
memoryBytesrequired	integer	at least 0
cpusrequired	integer	at least 0
featuresrequired	NodeFeatures
buildrequired	boolean
cloudflareTunnelrequired	boolean
hostMetrics	boolean

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
agent
Type
NodeAgent
Description
versionrequired
Type
string
Description
up to 32 characters
commitrequired
Type
string
Description
up to 64 characters
builtAtrequired
Type
string
Description
up to 32 characters
sealing
Type
NodeSealing
Description
algorithmrequired
Type
string
Description
one of "x25519-hkdf-sha256-aes256gcm"
publicKeyrequired
Type
string
Description
matches ^[A-Za-z0-9+/]{43}=$
platformrequired
Type
NodePlatform
Description
osrequired
Type
string
Description
at least 1 character
architecturerequired
Type
string
Description
at least 1 character
kernel
Type
string
Description
1 to 64 characters
runtimerequired
Type
NodeRuntime
Description
dockerrequired
Type
boolean
Description
versionrequired
Type
string
Description
capacityrequired
Type
NodeCapacity
Description
memoryBytesrequired
Type
integer
Description
at least 0
cpusrequired
Type
integer
Description
at least 0
featuresrequired
Type
NodeFeatures
Description
buildrequired
Type
boolean
Description
cloudflareTunnelrequired
Type
boolean
Description
hostMetrics
Type
boolean
Description

Response 200The node as it is now recorded

Response of updateNode
Field	Type	Description
datarequired	Node
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
agent	NodeAgent
sealing	NodeSealing
platformrequired	NodePlatform
runtimerequired	NodeRuntime
capacityrequired	NodeCapacity
featuresrequired	NodeFeatures
registeredAtrequired	string, date-time
lastSeenAtrequired	string, date-time
generationrequired	integer	at least 0

datarequired
Type
Node
Description
nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
agent
Type
NodeAgent
Description
sealing
Type
NodeSealing
Description
platformrequired
Type
NodePlatform
Description
runtimerequired
Type
NodeRuntime
Description
capacityrequired
Type
NodeCapacity
Description
featuresrequired
Type
NodeFeatures
Description
registeredAtrequired
Type
string, date-time
Description
lastSeenAtrequired
Type
string, date-time
Description
generationrequired
Type
integer
Description
at least 0

Example

curl

curl -X POST https://api.rsx.group/node/v1/nodes/update \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "nodeId": "macbook-dev-01",
  "agent": {
    "version": "0.1.0",
    "commit": "5036308f9859",
    "builtAt": "2026-08-30T23:30:34Z"
  },
  "sealing": {
    "algorithm": "x25519-hkdf-sha256-aes256gcm",
    "publicKey": "string"
  },
  "platform": {
    "os": "macos",
    "architecture": "x86_64",
    "kernel": "6.1.0-25-amd64"
  },
  "runtime": {
    "docker": true,
    "version": "29.6.2"
  },
  "capacity": {
    "memoryBytes": 8589934592,
    "cpus": 4
  },
  "features": {
    "build": true,
    "cloudflareTunnel": true,
    "hostMetrics": true
  }
}'

200 response

{
  "data": {
    "nodeId": "macbook-dev-01",
    "agent": {
      "version": "0.1.0",
      "commit": "5036308f9859",
      "builtAt": "2026-08-30T23:30:34Z"
    },
    "sealing": {
      "algorithm": "x25519-hkdf-sha256-aes256gcm",
      "publicKey": "string"
    },
    "platform": {
      "os": "macos",
      "architecture": "x86_64",
      "kernel": "6.1.0-25-amd64"
    },
    "runtime": {
      "docker": true,
      "version": "29.6.2"
    },
    "capacity": {
      "memoryBytes": 8589934592,
      "cpus": 4
    },
    "features": {
      "build": true,
      "cloudflareTunnel": true,
      "hostMetrics": true
    },
    "registeredAt": "2026-08-27T09:14:02Z",
    "lastSeenAt": "2026-08-27T09:41:55Z",
    "generation": 7
  }
}

GET/node/v1/nodes/list

List nodes and what each last reported

Scope: node:nodes:list Admin-issued keys only.

Query parameters

Query parameters of listNodes
Parameter	Type	Description
cursor	string
limit	integer	1 to 100 · default 20

cursor
Type
string
Description
limit
Type
integer
Description
1 to 100 · default 20

Response 200Nodes

Response of listNodes
Field	Type	Description
datarequired	array of NodeSummary
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
agent	NodeAgent
sealing	NodeSealing
platformrequired	NodePlatform
runtimerequired	NodeRuntime
capacityrequired	NodeCapacity
featuresrequired	NodeFeatures
registeredAtrequired	string, date-time
lastSeenAtrequired	string, date-time
generationrequired	integer	at least 0
statusrequired	NodeStatus
metarequired	object
cursorrequired	string, or null

datarequired
Type
array of NodeSummary
Description
nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
agent
Type
NodeAgent
Description
sealing
Type
NodeSealing
Description
platformrequired
Type
NodePlatform
Description
runtimerequired
Type
NodeRuntime
Description
capacityrequired
Type
NodeCapacity
Description
featuresrequired
Type
NodeFeatures
Description
registeredAtrequired
Type
string, date-time
Description
lastSeenAtrequired
Type
string, date-time
Description
generationrequired
Type
integer
Description
at least 0
statusrequired
Type
NodeStatus
Description
metarequired
Type
object
Description
cursorrequired
Type
string, or null
Description

Example

curl

curl "https://api.rsx.group/node/v1/nodes/list" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": [
    {
      "nodeId": "macbook-dev-01",
      "agent": {
        "version": "0.1.0",
        "commit": "5036308f9859",
        "builtAt": "2026-08-30T23:30:34Z"
      },
      "sealing": {
        "algorithm": "x25519-hkdf-sha256-aes256gcm",
        "publicKey": "string"
      },
      "platform": {
        "os": "macos",
        "architecture": "x86_64",
        "kernel": "6.1.0-25-amd64"
      },
      "runtime": {
        "docker": true,
        "version": "29.6.2"
      },
      "capacity": {
        "memoryBytes": 8589934592,
        "cpus": 4
      },
      "features": {
        "build": true,
        "cloudflareTunnel": true,
        "hostMetrics": true
      },
      "registeredAt": "2026-08-27T09:14:02Z",
      "lastSeenAt": "2026-08-27T09:41:55Z",
      "generation": 7,
      "status": {
        "nodeId": "macbook-dev-01",
        "generation": 7,
        "status": "HEALTHY",
        "docker": "Docker 29.6.2 on linux/x86_64, 7.4 GiB memory, 12 CPUs",
        "workloads": [
          null
        ],
        "host": null,
        "jobs": [
          null
        ],
        "reportedAt": "2026-08-27T09:41:55Z"
      }
    }
  ],
  "meta": {
    "cursor": "string"
  }
}

desired

2 operations under /node/v1/desired.

GET/node/v1/desired/get

Fetch a node's desired state, if it has changed

Scope: node:desired:get Admin-issued keys only.

Query parameters

Query parameters of getNodeDesiredState
Parameter	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
since	integer, or null	at least 0 · default 0

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
since
Type
integer, or null
Description
at least 0 · default 0

Response 200Desired state, newer than the generation asked about

Response of getNodeDesiredState
Field	Type	Description
datarequired	NodeDesiredState
generationrequired	integer	at least 0
workloadsrequired	array of NodeWorkload
tunnel	object
imagerequired	string
revisionrequired	string
jobs	array of NodeJob	default []

datarequired
Type
NodeDesiredState
Description
generationrequired
Type
integer
Description
at least 0
workloadsrequired
Type
array of NodeWorkload
Description
tunnel
Type
object
Description
imagerequired
Type
string
Description
revisionrequired
Type
string
Description
jobs
Type
array of NodeJob
Description
default []

Example

curl

curl "https://api.rsx.group/node/v1/desired/get?nodeId=macbook-dev-01" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": {
    "generation": 7,
    "workloads": [
      {
        "id": "roxy",
        "state": "running",
        "source": {
          "repository": "git@github.com:RSXGroup/roxy.git",
          "revision": "7f31c2a",
          "build": "registry",
          "registry": null,
          "image": "ghcr.io/rsxgroup/roxy@sha256:28bd5fe8b56d1bd048e5babf5b10710ebe0bae67db86916198a6eec434943f8b"
        },
        "env": {},
        "volumes": [],
        "resources": {},
        "restart": "unless-stopped",
        "health": {
          "type": "process",
          "settleSeconds": 5
        },
        "command": [
          "string"
        ],
        "diagnostics": {
          "probes": {}
        },
        "ingress": {
          "port": 3000,
          "hostnames": [
            null
          ],
          "access": true
        }
      }
    ],
    "tunnel": {
      "image": "string",
      "revision": "string"
    },
    "jobs": []
  }
}

POST/node/v1/desired/update

Set what a node should be running

Scope: node:desired:update Admin-issued keys only.

Request bodyapplication/json

Request body of updateNodeDesiredState
Field	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
workloadsrequired	array of object
idrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
state	string	one of "running", "stopped" · default "running"
sourcerequired	object
repository	string
revisionrequired	string	1 to 64 characters
build	string	one of "registry", "local" · default "registry"
registry	NodeWorkloadRegistryRef
imagerequired	string
env	map of string	default {}
{key}	string	up to 4096 characters
volumes	array of NodeWorkloadVolume	default []
resources	NodeWorkloadResources	default {}
restart	string	one of "no", "always", "unless-stopped" · default "unless-stopped"
health	NodeWorkloadHealth	default {"type":"process","settleSeconds":5}
command	array of string
diagnostics	object
probes	map of array of string	default {}
{key}	array of string	1 to 32 items
ingress	NodeWorkloadIngress
jobs	array of object	default []
idrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
sourcerequired	object
repository	string
revisionrequired	string	1 to 64 characters
build	string	one of "registry", "local" · default "registry"
registry	NodeWorkloadRegistryRef
imagerequired	string
commandrequired	array of string	1 to 64 items
env	map of string	default {}
{key}	string	up to 4096 characters
volumes	array of NodeWorkloadVolume	default []
resources	NodeWorkloadResources	default {}
timeoutSeconds	integer	1 to 86400 · default 3600
retainRuns	integer	1 to 20 · default 5
trigger	NodeJobTrigger

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
workloadsrequired
Type
array of object
Description
idrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
state
Type
string
Description
one of "running", "stopped" · default "running"
sourcerequired
Type
object
Description
repository
Type
string
Description
revisionrequired
Type
string
Description
1 to 64 characters
build
Type
string
Description
one of "registry", "local" · default "registry"
registry
Type
NodeWorkloadRegistryRef
Description
imagerequired
Type
string
Description
env
Type
map of string
Description
default {}
{key}
Type
string
Description
up to 4096 characters
volumes
Type
array of NodeWorkloadVolume
Description
default []
resources
Type
NodeWorkloadResources
Description
default {}
restart
Type
string
Description
one of "no", "always", "unless-stopped" · default "unless-stopped"
health
Type
NodeWorkloadHealth
Description
default {"type":"process","settleSeconds":5}
command
Type
array of string
Description
diagnostics
Type
object
Description
probes
Type
map of array of string
Description
default {}
{key}
Type
array of string
Description
1 to 32 items
ingress
Type
NodeWorkloadIngress
Description
jobs
Type
array of object
Description
default []
idrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
sourcerequired
Type
object
Description
repository
Type
string
Description
revisionrequired
Type
string
Description
1 to 64 characters
build
Type
string
Description
one of "registry", "local" · default "registry"
registry
Type
NodeWorkloadRegistryRef
Description
imagerequired
Type
string
Description
commandrequired
Type
array of string
Description
1 to 64 items
env
Type
map of string
Description
default {}
{key}
Type
string
Description
up to 4096 characters
volumes
Type
array of NodeWorkloadVolume
Description
default []
resources
Type
NodeWorkloadResources
Description
default {}
timeoutSeconds
Type
integer
Description
1 to 86400 · default 3600
retainRuns
Type
integer
Description
1 to 20 · default 5
trigger
Type
NodeJobTrigger
Description

Response 200The new desired state, with the generation it was given

Response of updateNodeDesiredState
Field	Type	Description
datarequired	NodeDesiredState
generationrequired	integer	at least 0
workloadsrequired	array of NodeWorkload
tunnel	object
imagerequired	string
revisionrequired	string
jobs	array of NodeJob	default []

datarequired
Type
NodeDesiredState
Description
generationrequired
Type
integer
Description
at least 0
workloadsrequired
Type
array of NodeWorkload
Description
tunnel
Type
object
Description
imagerequired
Type
string
Description
revisionrequired
Type
string
Description
jobs
Type
array of NodeJob
Description
default []

Example

curl

curl -X POST https://api.rsx.group/node/v1/desired/update \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "nodeId": "macbook-dev-01",
  "workloads": [
    {
      "id": "roxy",
      "state": "running",
      "source": {
        "repository": "git@github.com:RSXGroup/roxy.git",
        "revision": "7f31c2a",
        "build": "registry",
        "registry": {
          "package": null,
          "version": null
        },
        "image": "ghcr.io/rsxgroup/roxy@sha256:28bd5fe8b56d1bd048e5babf5b10710ebe0bae67db86916198a6eec434943f8b"
      },
      "env": {},
      "volumes": [],
      "resources": {},
      "restart": "unless-stopped",
      "health": {
        "type": "process",
        "settleSeconds": 5
      },
      "command": [
        "string"
      ],
      "diagnostics": {
        "probes": {}
      },
      "ingress": {
        "port": 3000,
        "hostnames": [
          "logs.rsx.group"
        ],
        "access": true
      }
    }
  ],
  "jobs": []
}'

200 response

{
  "data": {
    "generation": 7,
    "workloads": [
      {
        "id": "roxy",
        "state": "running",
        "source": {
          "repository": "git@github.com:RSXGroup/roxy.git",
          "revision": "7f31c2a",
          "build": "registry",
          "registry": null,
          "image": "ghcr.io/rsxgroup/roxy@sha256:28bd5fe8b56d1bd048e5babf5b10710ebe0bae67db86916198a6eec434943f8b"
        },
        "env": {},
        "volumes": [],
        "resources": {},
        "restart": "unless-stopped",
        "health": {
          "type": "process",
          "settleSeconds": 5
        },
        "command": [
          "string"
        ],
        "diagnostics": {
          "probes": {}
        },
        "ingress": {
          "port": 3000,
          "hostnames": [
            null
          ],
          "access": true
        }
      }
    ],
    "tunnel": {
      "image": "string",
      "revision": "string"
    },
    "jobs": []
  }
}

status

1 operation under /node/v1/status.

POST/node/v1/status/update

Report what a node is actually running

Scope: node:status:update Admin-issued keys only.

Request bodyapplication/json

Request body of updateNodeStatus
Field	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
generationrequired	integer	at least 0
statusrequired	string	one of "HEALTHY", "DEGRADED"
dockerrequired	string, or null
workloadsrequired	array of NodeWorkloadStatus
workloadIdrequired	string	at least 1 character
revisionrequired	string
staterequired	string
restartsrequired	integer	at least 0
conditionrequired	string
health	string, or null	one of "STARTING", "HEALTHY", "UNHEALTHY"
version	object, or null
versionrequired	string, or null	up to 64 characters
commitrequired	string, or null	up to 64 characters
deployment	NodeWorkloadDeployment
host	NodeHostUsage
cpuPercentrequired	number, or null	0 to 100
memoryrequired	object, or null
usedBytesrequired	integer	at least 0
totalBytesrequired	integer	at least 0
disksrequired	array of object	up to 4 items
pathrequired	string	1 to 256 characters
usedBytesrequired	integer	at least 0
totalBytesrequired	integer	at least 0
jobs	array of NodeJobStatus	up to 100 items
jobIdrequired	string	1 to 63 characters
revisionrequired	string	1 to 128 characters
runrequired	NodeJobRun

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
generationrequired
Type
integer
Description
at least 0
statusrequired
Type
string
Description
one of "HEALTHY", "DEGRADED"
dockerrequired
Type
string, or null
Description
workloadsrequired
Type
array of NodeWorkloadStatus
Description
workloadIdrequired
Type
string
Description
at least 1 character
revisionrequired
Type
string
Description
staterequired
Type
string
Description
restartsrequired
Type
integer
Description
at least 0
conditionrequired
Type
string
Description
health
Type
string, or null
Description
one of "STARTING", "HEALTHY", "UNHEALTHY"
version
Type
object, or null
Description
versionrequired
Type
string, or null
Description
up to 64 characters
commitrequired
Type
string, or null
Description
up to 64 characters
deployment
Type
NodeWorkloadDeployment
Description
host
Type
NodeHostUsage
Description
cpuPercentrequired
Type
number, or null
Description
0 to 100
memoryrequired
Type
object, or null
Description
usedBytesrequired
Type
integer
Description
at least 0
totalBytesrequired
Type
integer
Description
at least 0
disksrequired
Type
array of object
Description
up to 4 items
pathrequired
Type
string
Description
1 to 256 characters
usedBytesrequired
Type
integer
Description
at least 0
totalBytesrequired
Type
integer
Description
at least 0
jobs
Type
array of NodeJobStatus
Description
up to 100 items
jobIdrequired
Type
string
Description
1 to 63 characters
revisionrequired
Type
string
Description
1 to 128 characters
runrequired
Type
NodeJobRun
Description

Response 200The report as it was recorded

Response of updateNodeStatus
Field	Type	Description
datarequired	object
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
generationrequired	integer	at least 0
statusrequired	string	one of "HEALTHY", "DEGRADED"
dockerrequired	string, or null
workloadsrequired	array of NodeWorkloadStatus
host	NodeHostUsage
jobs	array of NodeJobStatus	up to 100 items
reportedAtrequired	string, date-time

datarequired
Type
object
Description
nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
generationrequired
Type
integer
Description
at least 0
statusrequired
Type
string
Description
one of "HEALTHY", "DEGRADED"
dockerrequired
Type
string, or null
Description
workloadsrequired
Type
array of NodeWorkloadStatus
Description
host
Type
NodeHostUsage
Description
jobs
Type
array of NodeJobStatus
Description
up to 100 items
reportedAtrequired
Type
string, date-time
Description

Example

curl

curl -X POST https://api.rsx.group/node/v1/status/update \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "nodeId": "macbook-dev-01",
  "generation": 7,
  "status": "HEALTHY",
  "docker": "Docker 29.6.2 on linux/x86_64, 7.4 GiB memory, 12 CPUs",
  "workloads": [
    {
      "workloadId": "roxy",
      "revision": "7f31c2a",
      "state": "RUNNING",
      "restarts": 0,
      "condition": "READY",
      "health": "STARTING",
      "version": {
        "version": "string",
        "commit": "string"
      },
      "deployment": {
        "revision": "9a1b2c3",
        "outcome": "promoted",
        "detail": "its health check failed: connection refused",
        "at": "2026-10-09T09:14:02Z"
      }
    }
  ],
  "host": {
    "cpuPercent": 12.5,
    "memory": {
      "usedBytes": 6442450944,
      "totalBytes": 17179869184
    },
    "disks": [
      {
        "path": "/var/lib/docker",
        "usedBytes": 48318382080,
        "totalBytes": 107374182400
      }
    ]
  },
  "jobs": [
    {
      "jobId": "roxy-migrate",
      "revision": "7f31c2a",
      "run": {
        "runId": "01JD3M4K5N6P7Q8R9S0T1U2V3W",
        "revision": "7f31c2a",
        "state": "succeeded",
        "exitCode": 0,
        "startedAt": "2026-10-09T09:14:05Z",
        "finishedAt": "2026-10-09T09:14:41Z",
        "detail": "exited 0 after 36s"
      }
    }
  ]
}'

200 response

{
  "data": {
    "nodeId": "macbook-dev-01",
    "generation": 7,
    "status": "HEALTHY",
    "docker": "Docker 29.6.2 on linux/x86_64, 7.4 GiB memory, 12 CPUs",
    "workloads": [
      {
        "workloadId": "roxy",
        "revision": "7f31c2a",
        "state": "RUNNING",
        "restarts": 0,
        "condition": "READY",
        "health": "STARTING",
        "version": {
          "version": "string",
          "commit": "string"
        },
        "deployment": {
          "revision": "9a1b2c3",
          "outcome": null,
          "detail": "its health check failed: connection refused",
          "at": "2026-10-09T09:14:02Z"
        }
      }
    ],
    "host": {
      "cpuPercent": 12.5,
      "memory": {
        "usedBytes": 6442450944,
        "totalBytes": 17179869184
      },
      "disks": [
        {
          "path": "/var/lib/docker",
          "usedBytes": 48318382080,
          "totalBytes": 107374182400
        }
      ]
    },
    "jobs": [
      {
        "jobId": "roxy-migrate",
        "revision": "7f31c2a",
        "run": {
          "runId": "01JD3M4K5N6P7Q8R9S0T1U2V3W",
          "revision": "7f31c2a",
          "state": "succeeded",
          "exitCode": 0,
          "startedAt": "2026-10-09T09:14:05Z",
          "finishedAt": "2026-10-09T09:14:41Z",
          "detail": "exited 0 after 36s"
        }
      }
    ],
    "reportedAt": "2026-08-27T09:41:55Z"
  }
}

commands

2 operations under /node/v1/commands.

GET/node/v1/commands/get

Anything asked of this node since it last answered

Scope: node:commands:get Admin-issued keys only.

Query parameters

Query parameters of getNodeCommands
Parameter	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$

Response 200Pending commands, oldest first

Response of getNodeCommands
Field	Type	Description
datarequired	array of NodeCommand
idrequired	string
kindrequired	string	one of "reconcile", "restart", "redeploy", "logs", "diagnose", "secret", "update", "reboot", "shutdown", "run"
arguments	map of any	default {}
{key}	any
issuedAtrequired	string, date-time
issuedByrequired	string

datarequired
Type
array of NodeCommand
Description
idrequired
Type
string
Description
kindrequired
Type
string
Description
one of "reconcile", "restart", "redeploy", "logs", "diagnose", "secret", "update", "reboot", "shutdown", "run"
arguments
Type
map of any
Description
default {}
{key}
Type
any
Description
issuedAtrequired
Type
string, date-time
Description
issuedByrequired
Type
string
Description

Example

curl

curl "https://api.rsx.group/node/v1/commands/get?nodeId=macbook-dev-01" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": [
    {
      "id": "01JD3M4K5N6P7Q8R9S0T1U2V3W",
      "kind": "restart",
      "arguments": {},
      "issuedAt": "2026-08-31T09:14:02Z",
      "issuedBy": "paige@rsx.group"
    }
  ]
}

POST/node/v1/commands/ack

Record what came of a command

Scope: node:commands:ack Admin-issued keys only.

Request bodyapplication/json

Request body of ackNodeCommand
Field	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
commandIdrequired	string	1 to 64 characters
outcomerequired	string	one of "done", "failed"
detail	string	up to 2000 characters · default ""
output	string, or null	up to 200000 characters · default null

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
commandIdrequired
Type
string
Description
1 to 64 characters
outcomerequired
Type
string
Description
one of "done", "failed"
detail
Type
string
Description
up to 2000 characters · default ""
output
Type
string, or null
Description
up to 200000 characters · default null

Response 200Whether there was a pending command to acknowledge

Response of ackNodeCommand
Field	Type	Description
datarequired	object
acknowledgedrequired	boolean

datarequired
Type
object
Description
acknowledgedrequired
Type
boolean
Description

Example

curl

curl -X POST https://api.rsx.group/node/v1/commands/ack \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "nodeId": "macbook-dev-01",
  "commandId": "string",
  "outcome": "done",
  "detail": "",
  "output": null
}'

200 response

{
  "data": {
    "acknowledged": true
  }
}

Schemas

Every named shape in this reference, as the operations above refer to it.

NodeAgent

NodeAgent
Field	Type	Description
versionrequired	string	up to 32 characters
commitrequired	string	up to 64 characters
builtAtrequired	string	up to 32 characters

versionrequired
Type
string
Description
up to 32 characters
commitrequired
Type
string
Description
up to 64 characters
builtAtrequired
Type
string
Description
up to 32 characters

NodeSealing

NodeSealing
Field	Type	Description
algorithmrequired	string	one of "x25519-hkdf-sha256-aes256gcm"
publicKeyrequired	string	matches ^[A-Za-z0-9+/]{43}=$

algorithmrequired
Type
string
Description
one of "x25519-hkdf-sha256-aes256gcm"
publicKeyrequired
Type
string
Description
matches ^[A-Za-z0-9+/]{43}=$

NodePlatform

NodePlatform
Field	Type	Description
osrequired	string	at least 1 character
architecturerequired	string	at least 1 character
kernel	string	1 to 64 characters

osrequired
Type
string
Description
at least 1 character
architecturerequired
Type
string
Description
at least 1 character
kernel
Type
string
Description
1 to 64 characters

NodeRuntime

NodeRuntime
Field	Type	Description
dockerrequired	boolean
versionrequired	string

dockerrequired
Type
boolean
Description
versionrequired
Type
string
Description

NodeCapacity

NodeCapacity
Field	Type	Description
memoryBytesrequired	integer	at least 0
cpusrequired	integer	at least 0

memoryBytesrequired
Type
integer
Description
at least 0
cpusrequired
Type
integer
Description
at least 0

NodeFeatures

NodeFeatures
Field	Type	Description
buildrequired	boolean
cloudflareTunnelrequired	boolean
hostMetrics	boolean

buildrequired
Type
boolean
Description
cloudflareTunnelrequired
Type
boolean
Description
hostMetrics
Type
boolean
Description

NodeDeploymentOutcome

string

NodeWorkloadDeployment

NodeWorkloadDeployment
Field	Type	Description
revisionrequired	string	1 to 128 characters
outcomerequired	NodeDeploymentOutcome	one of "promoted", "rolled-back", "failed"
detailrequired	string	up to 1024 characters
atrequired	string, date-time

revisionrequired
Type
string
Description
1 to 128 characters
outcomerequired
Type
NodeDeploymentOutcome
Description
one of "promoted", "rolled-back", "failed"
detailrequired
Type
string
Description
up to 1024 characters
atrequired
Type
string, date-time
Description

NodeWorkloadStatus

NodeWorkloadStatus
Field	Type	Description
workloadIdrequired	string	at least 1 character
revisionrequired	string
staterequired	string
restartsrequired	integer	at least 0
conditionrequired	string
health	string, or null	one of "STARTING", "HEALTHY", "UNHEALTHY"
version	object, or null
versionrequired	string, or null	up to 64 characters
commitrequired	string, or null	up to 64 characters
deployment	NodeWorkloadDeployment
revisionrequired	string	1 to 128 characters
outcomerequired	NodeDeploymentOutcome	one of "promoted", "rolled-back", "failed"
detailrequired	string	up to 1024 characters
atrequired	string, date-time

workloadIdrequired
Type
string
Description
at least 1 character
revisionrequired
Type
string
Description
staterequired
Type
string
Description
restartsrequired
Type
integer
Description
at least 0
conditionrequired
Type
string
Description
health
Type
string, or null
Description
one of "STARTING", "HEALTHY", "UNHEALTHY"
version
Type
object, or null
Description
versionrequired
Type
string, or null
Description
up to 64 characters
commitrequired
Type
string, or null
Description
up to 64 characters
deployment
Type
NodeWorkloadDeployment
Description
revisionrequired
Type
string
Description
1 to 128 characters
outcomerequired
Type
NodeDeploymentOutcome
Description
one of "promoted", "rolled-back", "failed"
detailrequired
Type
string
Description
up to 1024 characters
atrequired
Type
string, date-time
Description

NodeHostUsage

NodeHostUsage
Field	Type	Description
cpuPercentrequired	number, or null	0 to 100
memoryrequired	object, or null
usedBytesrequired	integer	at least 0
totalBytesrequired	integer	at least 0
disksrequired	array of object	up to 4 items
pathrequired	string	1 to 256 characters
usedBytesrequired	integer	at least 0
totalBytesrequired	integer	at least 0

cpuPercentrequired
Type
number, or null
Description
0 to 100
memoryrequired
Type
object, or null
Description
usedBytesrequired
Type
integer
Description
at least 0
totalBytesrequired
Type
integer
Description
at least 0
disksrequired
Type
array of object
Description
up to 4 items
pathrequired
Type
string
Description
1 to 256 characters
usedBytesrequired
Type
integer
Description
at least 0
totalBytesrequired
Type
integer
Description
at least 0

NodeJobRun

NodeJobRun
Field	Type	Description
runIdrequired	string	1 to 64 characters
revisionrequired	string	1 to 128 characters
staterequired	string	one of "running", "succeeded", "failed", "timed-out"
exitCoderequired	integer, or null
startedAtrequired	string, date-time, or null
finishedAtrequired	string, date-time, or null
detailrequired	string	up to 1024 characters

runIdrequired
Type
string
Description
1 to 64 characters
revisionrequired
Type
string
Description
1 to 128 characters
staterequired
Type
string
Description
one of "running", "succeeded", "failed", "timed-out"
exitCoderequired
Type
integer, or null
Description
startedAtrequired
Type
string, date-time, or null
Description
finishedAtrequired
Type
string, date-time, or null
Description
detailrequired
Type
string
Description
up to 1024 characters

NodeJobStatus

NodeJobStatus
Field	Type	Description
jobIdrequired	string	1 to 63 characters
revisionrequired	string	1 to 128 characters
runrequired	NodeJobRun
runIdrequired	string	1 to 64 characters
revisionrequired	string	1 to 128 characters
staterequired	string	one of "running", "succeeded", "failed", "timed-out"
exitCoderequired	integer, or null
startedAtrequired	string, date-time, or null
finishedAtrequired	string, date-time, or null
detailrequired	string	up to 1024 characters

jobIdrequired
Type
string
Description
1 to 63 characters
revisionrequired
Type
string
Description
1 to 128 characters
runrequired
Type
NodeJobRun
Description
runIdrequired
Type
string
Description
1 to 64 characters
revisionrequired
Type
string
Description
1 to 128 characters
staterequired
Type
string
Description
one of "running", "succeeded", "failed", "timed-out"
exitCoderequired
Type
integer, or null
Description
startedAtrequired
Type
string, date-time, or null
Description
finishedAtrequired
Type
string, date-time, or null
Description
detailrequired
Type
string
Description
up to 1024 characters

UpdateNodeStatus

UpdateNodeStatus
Field	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
generationrequired	integer	at least 0
statusrequired	string	one of "HEALTHY", "DEGRADED"
dockerrequired	string, or null
workloadsrequired	array of NodeWorkloadStatus
workloadIdrequired	string	at least 1 character
revisionrequired	string
staterequired	string
restartsrequired	integer	at least 0
conditionrequired	string
health	string, or null	one of "STARTING", "HEALTHY", "UNHEALTHY"
version	object, or null
versionrequired	string, or null	up to 64 characters
commitrequired	string, or null	up to 64 characters
deployment	NodeWorkloadDeployment
host	NodeHostUsage
cpuPercentrequired	number, or null	0 to 100
memoryrequired	object, or null
usedBytesrequired	integer	at least 0
totalBytesrequired	integer	at least 0
disksrequired	array of object	up to 4 items
pathrequired	string	1 to 256 characters
usedBytesrequired	integer	at least 0
totalBytesrequired	integer	at least 0
jobs	array of NodeJobStatus	up to 100 items
jobIdrequired	string	1 to 63 characters
revisionrequired	string	1 to 128 characters
runrequired	NodeJobRun

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
generationrequired
Type
integer
Description
at least 0
statusrequired
Type
string
Description
one of "HEALTHY", "DEGRADED"
dockerrequired
Type
string, or null
Description
workloadsrequired
Type
array of NodeWorkloadStatus
Description
workloadIdrequired
Type
string
Description
at least 1 character
revisionrequired
Type
string
Description
staterequired
Type
string
Description
restartsrequired
Type
integer
Description
at least 0
conditionrequired
Type
string
Description
health
Type
string, or null
Description
one of "STARTING", "HEALTHY", "UNHEALTHY"
version
Type
object, or null
Description
versionrequired
Type
string, or null
Description
up to 64 characters
commitrequired
Type
string, or null
Description
up to 64 characters
deployment
Type
NodeWorkloadDeployment
Description
host
Type
NodeHostUsage
Description
cpuPercentrequired
Type
number, or null
Description
0 to 100
memoryrequired
Type
object, or null
Description
usedBytesrequired
Type
integer
Description
at least 0
totalBytesrequired
Type
integer
Description
at least 0
disksrequired
Type
array of object
Description
up to 4 items
pathrequired
Type
string
Description
1 to 256 characters
usedBytesrequired
Type
integer
Description
at least 0
totalBytesrequired
Type
integer
Description
at least 0
jobs
Type
array of NodeJobStatus
Description
up to 100 items
jobIdrequired
Type
string
Description
1 to 63 characters
revisionrequired
Type
string
Description
1 to 128 characters
runrequired
Type
NodeJobRun
Description

NodeStatus

NodeStatus
Field	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
generationrequired	integer	at least 0
statusrequired	string	one of "HEALTHY", "DEGRADED"
dockerrequired	string, or null
workloadsrequired	array of NodeWorkloadStatus
workloadIdrequired	string	at least 1 character
revisionrequired	string
staterequired	string
restartsrequired	integer	at least 0
conditionrequired	string
health	string, or null	one of "STARTING", "HEALTHY", "UNHEALTHY"
version	object, or null
versionrequired	string, or null	up to 64 characters
commitrequired	string, or null	up to 64 characters
deployment	NodeWorkloadDeployment
host	NodeHostUsage
cpuPercentrequired	number, or null	0 to 100
memoryrequired	object, or null
usedBytesrequired	integer	at least 0
totalBytesrequired	integer	at least 0
disksrequired	array of object	up to 4 items
pathrequired	string	1 to 256 characters
usedBytesrequired	integer	at least 0
totalBytesrequired	integer	at least 0
jobs	array of NodeJobStatus	up to 100 items
jobIdrequired	string	1 to 63 characters
revisionrequired	string	1 to 128 characters
runrequired	NodeJobRun
reportedAtrequired	string, date-time

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
generationrequired
Type
integer
Description
at least 0
statusrequired
Type
string
Description
one of "HEALTHY", "DEGRADED"
dockerrequired
Type
string, or null
Description
workloadsrequired
Type
array of NodeWorkloadStatus
Description
workloadIdrequired
Type
string
Description
at least 1 character
revisionrequired
Type
string
Description
staterequired
Type
string
Description
restartsrequired
Type
integer
Description
at least 0
conditionrequired
Type
string
Description
health
Type
string, or null
Description
one of "STARTING", "HEALTHY", "UNHEALTHY"
version
Type
object, or null
Description
versionrequired
Type
string, or null
Description
up to 64 characters
commitrequired
Type
string, or null
Description
up to 64 characters
deployment
Type
NodeWorkloadDeployment
Description
host
Type
NodeHostUsage
Description
cpuPercentrequired
Type
number, or null
Description
0 to 100
memoryrequired
Type
object, or null
Description
usedBytesrequired
Type
integer
Description
at least 0
totalBytesrequired
Type
integer
Description
at least 0
disksrequired
Type
array of object
Description
up to 4 items
pathrequired
Type
string
Description
1 to 256 characters
usedBytesrequired
Type
integer
Description
at least 0
totalBytesrequired
Type
integer
Description
at least 0
jobs
Type
array of NodeJobStatus
Description
up to 100 items
jobIdrequired
Type
string
Description
1 to 63 characters
revisionrequired
Type
string
Description
1 to 128 characters
runrequired
Type
NodeJobRun
Description
reportedAtrequired
Type
string, date-time
Description

RegisterNode

RegisterNode
Field	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
agent	NodeAgent
versionrequired	string	up to 32 characters
commitrequired	string	up to 64 characters
builtAtrequired	string	up to 32 characters
sealing	NodeSealing
algorithmrequired	string	one of "x25519-hkdf-sha256-aes256gcm"
publicKeyrequired	string	matches ^[A-Za-z0-9+/]{43}=$
platformrequired	NodePlatform
osrequired	string	at least 1 character
architecturerequired	string	at least 1 character
kernel	string	1 to 64 characters
runtimerequired	NodeRuntime
dockerrequired	boolean
versionrequired	string
capacityrequired	NodeCapacity
memoryBytesrequired	integer	at least 0
cpusrequired	integer	at least 0
featuresrequired	NodeFeatures
buildrequired	boolean
cloudflareTunnelrequired	boolean
hostMetrics	boolean

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
agent
Type
NodeAgent
Description
versionrequired
Type
string
Description
up to 32 characters
commitrequired
Type
string
Description
up to 64 characters
builtAtrequired
Type
string
Description
up to 32 characters
sealing
Type
NodeSealing
Description
algorithmrequired
Type
string
Description
one of "x25519-hkdf-sha256-aes256gcm"
publicKeyrequired
Type
string
Description
matches ^[A-Za-z0-9+/]{43}=$
platformrequired
Type
NodePlatform
Description
osrequired
Type
string
Description
at least 1 character
architecturerequired
Type
string
Description
at least 1 character
kernel
Type
string
Description
1 to 64 characters
runtimerequired
Type
NodeRuntime
Description
dockerrequired
Type
boolean
Description
versionrequired
Type
string
Description
capacityrequired
Type
NodeCapacity
Description
memoryBytesrequired
Type
integer
Description
at least 0
cpusrequired
Type
integer
Description
at least 0
featuresrequired
Type
NodeFeatures
Description
buildrequired
Type
boolean
Description
cloudflareTunnelrequired
Type
boolean
Description
hostMetrics
Type
boolean
Description

Node

Node
Field	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
agent	NodeAgent
versionrequired	string	up to 32 characters
commitrequired	string	up to 64 characters
builtAtrequired	string	up to 32 characters
sealing	NodeSealing
algorithmrequired	string	one of "x25519-hkdf-sha256-aes256gcm"
publicKeyrequired	string	matches ^[A-Za-z0-9+/]{43}=$
platformrequired	NodePlatform
osrequired	string	at least 1 character
architecturerequired	string	at least 1 character
kernel	string	1 to 64 characters
runtimerequired	NodeRuntime
dockerrequired	boolean
versionrequired	string
capacityrequired	NodeCapacity
memoryBytesrequired	integer	at least 0
cpusrequired	integer	at least 0
featuresrequired	NodeFeatures
buildrequired	boolean
cloudflareTunnelrequired	boolean
hostMetrics	boolean
registeredAtrequired	string, date-time
lastSeenAtrequired	string, date-time
generationrequired	integer	at least 0

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
agent
Type
NodeAgent
Description
versionrequired
Type
string
Description
up to 32 characters
commitrequired
Type
string
Description
up to 64 characters
builtAtrequired
Type
string
Description
up to 32 characters
sealing
Type
NodeSealing
Description
algorithmrequired
Type
string
Description
one of "x25519-hkdf-sha256-aes256gcm"
publicKeyrequired
Type
string
Description
matches ^[A-Za-z0-9+/]{43}=$
platformrequired
Type
NodePlatform
Description
osrequired
Type
string
Description
at least 1 character
architecturerequired
Type
string
Description
at least 1 character
kernel
Type
string
Description
1 to 64 characters
runtimerequired
Type
NodeRuntime
Description
dockerrequired
Type
boolean
Description
versionrequired
Type
string
Description
capacityrequired
Type
NodeCapacity
Description
memoryBytesrequired
Type
integer
Description
at least 0
cpusrequired
Type
integer
Description
at least 0
featuresrequired
Type
NodeFeatures
Description
buildrequired
Type
boolean
Description
cloudflareTunnelrequired
Type
boolean
Description
hostMetrics
Type
boolean
Description
registeredAtrequired
Type
string, date-time
Description
lastSeenAtrequired
Type
string, date-time
Description
generationrequired
Type
integer
Description
at least 0

NodeSummary

NodeSummary
Field	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
agent	NodeAgent
versionrequired	string	up to 32 characters
commitrequired	string	up to 64 characters
builtAtrequired	string	up to 32 characters
sealing	NodeSealing
algorithmrequired	string	one of "x25519-hkdf-sha256-aes256gcm"
publicKeyrequired	string	matches ^[A-Za-z0-9+/]{43}=$
platformrequired	NodePlatform
osrequired	string	at least 1 character
architecturerequired	string	at least 1 character
kernel	string	1 to 64 characters
runtimerequired	NodeRuntime
dockerrequired	boolean
versionrequired	string
capacityrequired	NodeCapacity
memoryBytesrequired	integer	at least 0
cpusrequired	integer	at least 0
featuresrequired	NodeFeatures
buildrequired	boolean
cloudflareTunnelrequired	boolean
hostMetrics	boolean
registeredAtrequired	string, date-time
lastSeenAtrequired	string, date-time
generationrequired	integer	at least 0
statusrequired	NodeStatus
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
generationrequired	integer	at least 0
statusrequired	string	one of "HEALTHY", "DEGRADED"
dockerrequired	string, or null
workloadsrequired	array of NodeWorkloadStatus
host	NodeHostUsage
jobs	array of NodeJobStatus	up to 100 items
reportedAtrequired	string, date-time

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
agent
Type
NodeAgent
Description
versionrequired
Type
string
Description
up to 32 characters
commitrequired
Type
string
Description
up to 64 characters
builtAtrequired
Type
string
Description
up to 32 characters
sealing
Type
NodeSealing
Description
algorithmrequired
Type
string
Description
one of "x25519-hkdf-sha256-aes256gcm"
publicKeyrequired
Type
string
Description
matches ^[A-Za-z0-9+/]{43}=$
platformrequired
Type
NodePlatform
Description
osrequired
Type
string
Description
at least 1 character
architecturerequired
Type
string
Description
at least 1 character
kernel
Type
string
Description
1 to 64 characters
runtimerequired
Type
NodeRuntime
Description
dockerrequired
Type
boolean
Description
versionrequired
Type
string
Description
capacityrequired
Type
NodeCapacity
Description
memoryBytesrequired
Type
integer
Description
at least 0
cpusrequired
Type
integer
Description
at least 0
featuresrequired
Type
NodeFeatures
Description
buildrequired
Type
boolean
Description
cloudflareTunnelrequired
Type
boolean
Description
hostMetrics
Type
boolean
Description
registeredAtrequired
Type
string, date-time
Description
lastSeenAtrequired
Type
string, date-time
Description
generationrequired
Type
integer
Description
at least 0
statusrequired
Type
NodeStatus
Description
nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
generationrequired
Type
integer
Description
at least 0
statusrequired
Type
string
Description
one of "HEALTHY", "DEGRADED"
dockerrequired
Type
string, or null
Description
workloadsrequired
Type
array of NodeWorkloadStatus
Description
host
Type
NodeHostUsage
Description
jobs
Type
array of NodeJobStatus
Description
up to 100 items
reportedAtrequired
Type
string, date-time
Description

NodeDetail

NodeDetail
Field	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
agent	NodeAgent
versionrequired	string	up to 32 characters
commitrequired	string	up to 64 characters
builtAtrequired	string	up to 32 characters
sealing	NodeSealing
algorithmrequired	string	one of "x25519-hkdf-sha256-aes256gcm"
publicKeyrequired	string	matches ^[A-Za-z0-9+/]{43}=$
platformrequired	NodePlatform
osrequired	string	at least 1 character
architecturerequired	string	at least 1 character
kernel	string	1 to 64 characters
runtimerequired	NodeRuntime
dockerrequired	boolean
versionrequired	string
capacityrequired	NodeCapacity
memoryBytesrequired	integer	at least 0
cpusrequired	integer	at least 0
featuresrequired	NodeFeatures
buildrequired	boolean
cloudflareTunnelrequired	boolean
hostMetrics	boolean
registeredAtrequired	string, date-time
lastSeenAtrequired	string, date-time
generationrequired	integer	at least 0
statusrequired	NodeStatus
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
generationrequired	integer	at least 0
statusrequired	string	one of "HEALTHY", "DEGRADED"
dockerrequired	string, or null
workloadsrequired	array of NodeWorkloadStatus
host	NodeHostUsage
jobs	array of NodeJobStatus	up to 100 items
reportedAtrequired	string, date-time
desiredrequired	string, or null

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
agent
Type
NodeAgent
Description
versionrequired
Type
string
Description
up to 32 characters
commitrequired
Type
string
Description
up to 64 characters
builtAtrequired
Type
string
Description
up to 32 characters
sealing
Type
NodeSealing
Description
algorithmrequired
Type
string
Description
one of "x25519-hkdf-sha256-aes256gcm"
publicKeyrequired
Type
string
Description
matches ^[A-Za-z0-9+/]{43}=$
platformrequired
Type
NodePlatform
Description
osrequired
Type
string
Description
at least 1 character
architecturerequired
Type
string
Description
at least 1 character
kernel
Type
string
Description
1 to 64 characters
runtimerequired
Type
NodeRuntime
Description
dockerrequired
Type
boolean
Description
versionrequired
Type
string
Description
capacityrequired
Type
NodeCapacity
Description
memoryBytesrequired
Type
integer
Description
at least 0
cpusrequired
Type
integer
Description
at least 0
featuresrequired
Type
NodeFeatures
Description
buildrequired
Type
boolean
Description
cloudflareTunnelrequired
Type
boolean
Description
hostMetrics
Type
boolean
Description
registeredAtrequired
Type
string, date-time
Description
lastSeenAtrequired
Type
string, date-time
Description
generationrequired
Type
integer
Description
at least 0
statusrequired
Type
NodeStatus
Description
nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
generationrequired
Type
integer
Description
at least 0
statusrequired
Type
string
Description
one of "HEALTHY", "DEGRADED"
dockerrequired
Type
string, or null
Description
workloadsrequired
Type
array of NodeWorkloadStatus
Description
host
Type
NodeHostUsage
Description
jobs
Type
array of NodeJobStatus
Description
up to 100 items
reportedAtrequired
Type
string, date-time
Description
desiredrequired
Type
string, or null
Description

NodeWorkloadRegistryRef

NodeWorkloadRegistryRef
Field	Type	Description
packagerequired	string	1 to 255 characters
versionrequired	string	1 to 128 characters

packagerequired
Type
string
Description
1 to 255 characters
versionrequired
Type
string
Description
1 to 128 characters

NodeWorkloadSource

NodeWorkloadSource
Field	Type	Description
repository	string
revisionrequired	string	1 to 64 characters
build	string	one of "registry", "local" · default "registry"
registry	NodeWorkloadRegistryRef
packagerequired	string	1 to 255 characters
versionrequired	string	1 to 128 characters
imagerequired	string

repository
Type
string
Description
revisionrequired
Type
string
Description
1 to 64 characters
build
Type
string
Description
one of "registry", "local" · default "registry"
registry
Type
NodeWorkloadRegistryRef
Description
packagerequired
Type
string
Description
1 to 255 characters
versionrequired
Type
string
Description
1 to 128 characters
imagerequired
Type
string
Description

NodeWorkloadVolume

NodeWorkloadVolume
Field	Type	Description
namerequired	string	1 to 63 characters · matches ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
pathrequired	string

namerequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
pathrequired
Type
string
Description

NodeWorkloadResources

NodeWorkloadResources
Field	Type	Description
memory	string	matches ^\d+(B\|[KMGT]i?)?$
cpu	number	more than 0

memory
Type
string
Description
matches ^\d+(B|[KMGT]i?)?$
cpu
Type
number
Description
more than 0

NodeWorkloadHealth

one of object, object

NodeWorkloadIngress

NodeWorkloadIngress
Field	Type	Description
portrequired	integer	1 to 65535
hostnamesrequired	array of string	1 to 10 items
access	boolean	default true

portrequired
Type
integer
Description
1 to 65535
hostnamesrequired
Type
array of string
Description
1 to 10 items
access
Type
boolean
Description
default true

NodeWorkload

NodeWorkload
Field	Type	Description
idrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
state	string	one of "running", "stopped" · default "running"
sourcerequired	NodeWorkloadSource
repository	string
revisionrequired	string	1 to 64 characters
build	string	one of "registry", "local" · default "registry"
registry	NodeWorkloadRegistryRef
imagerequired	string
env	map of string	default {}
{key}	string	up to 4096 characters
volumes	array of NodeWorkloadVolume	default []
namerequired	string	1 to 63 characters · matches ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
pathrequired	string
resources	NodeWorkloadResources	default {}
memory	string	matches ^\d+(B\|[KMGT]i?)?$
cpu	number	more than 0
restart	string	one of "no", "always", "unless-stopped" · default "unless-stopped"
health	NodeWorkloadHealth	default {"type":"process","settleSeconds":5}
command	array of string
diagnostics	object
probes	map of array of string	default {}
{key}	array of string	1 to 32 items
ingress	NodeWorkloadIngress
portrequired	integer	1 to 65535
hostnamesrequired	array of string	1 to 10 items
access	boolean	default true

idrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
state
Type
string
Description
one of "running", "stopped" · default "running"
sourcerequired
Type
NodeWorkloadSource
Description
repository
Type
string
Description
revisionrequired
Type
string
Description
1 to 64 characters
build
Type
string
Description
one of "registry", "local" · default "registry"
registry
Type
NodeWorkloadRegistryRef
Description
imagerequired
Type
string
Description
env
Type
map of string
Description
default {}
{key}
Type
string
Description
up to 4096 characters
volumes
Type
array of NodeWorkloadVolume
Description
default []
namerequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
pathrequired
Type
string
Description
resources
Type
NodeWorkloadResources
Description
default {}
memory
Type
string
Description
matches ^\d+(B|[KMGT]i?)?$
cpu
Type
number
Description
more than 0
restart
Type
string
Description
one of "no", "always", "unless-stopped" · default "unless-stopped"
health
Type
NodeWorkloadHealth
Description
default {"type":"process","settleSeconds":5}
command
Type
array of string
Description
diagnostics
Type
object
Description
probes
Type
map of array of string
Description
default {}
{key}
Type
array of string
Description
1 to 32 items
ingress
Type
NodeWorkloadIngress
Description
portrequired
Type
integer
Description
1 to 65535
hostnamesrequired
Type
array of string
Description
1 to 10 items
access
Type
boolean
Description
default true

NodeJobTrigger

NodeJobTrigger
Field	Type	Description
githubrequired	object
repositoryrequired	string	3 to 140 characters · matches ^[A-Za-z0-9._-]+\/[A-Za-z0-9._-]+$
refsrequired	array of string	1 to 10 items

githubrequired
Type
object
Description
repositoryrequired
Type
string
Description
3 to 140 characters · matches ^[A-Za-z0-9._-]+\/[A-Za-z0-9._-]+$
refsrequired
Type
array of string
Description
1 to 10 items

NodeJob

NodeJob
Field	Type	Description
idrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
sourcerequired	NodeWorkloadSource
repository	string
revisionrequired	string	1 to 64 characters
build	string	one of "registry", "local" · default "registry"
registry	NodeWorkloadRegistryRef
imagerequired	string
commandrequired	array of string	1 to 64 items
env	map of string	default {}
{key}	string	up to 4096 characters
volumes	array of NodeWorkloadVolume	default []
namerequired	string	1 to 63 characters · matches ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
pathrequired	string
resources	NodeWorkloadResources	default {}
memory	string	matches ^\d+(B\|[KMGT]i?)?$
cpu	number	more than 0
timeoutSeconds	integer	1 to 86400 · default 3600
retainRuns	integer	1 to 20 · default 5
trigger	NodeJobTrigger
githubrequired	object
repositoryrequired	string	3 to 140 characters · matches ^[A-Za-z0-9._-]+\/[A-Za-z0-9._-]+$
refsrequired	array of string	1 to 10 items

idrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
sourcerequired
Type
NodeWorkloadSource
Description
repository
Type
string
Description
revisionrequired
Type
string
Description
1 to 64 characters
build
Type
string
Description
one of "registry", "local" · default "registry"
registry
Type
NodeWorkloadRegistryRef
Description
imagerequired
Type
string
Description
commandrequired
Type
array of string
Description
1 to 64 items
env
Type
map of string
Description
default {}
{key}
Type
string
Description
up to 4096 characters
volumes
Type
array of NodeWorkloadVolume
Description
default []
namerequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
pathrequired
Type
string
Description
resources
Type
NodeWorkloadResources
Description
default {}
memory
Type
string
Description
matches ^\d+(B|[KMGT]i?)?$
cpu
Type
number
Description
more than 0
timeoutSeconds
Type
integer
Description
1 to 86400 · default 3600
retainRuns
Type
integer
Description
1 to 20 · default 5
trigger
Type
NodeJobTrigger
Description
githubrequired
Type
object
Description
repositoryrequired
Type
string
Description
3 to 140 characters · matches ^[A-Za-z0-9._-]+\/[A-Za-z0-9._-]+$
refsrequired
Type
array of string
Description
1 to 10 items

UpdateNodeDesiredState

UpdateNodeDesiredState
Field	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
workloadsrequired	array of object
idrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
state	string	one of "running", "stopped" · default "running"
sourcerequired	object
repository	string
revisionrequired	string	1 to 64 characters
build	string	one of "registry", "local" · default "registry"
registry	NodeWorkloadRegistryRef
imagerequired	string
env	map of string	default {}
{key}	string	up to 4096 characters
volumes	array of NodeWorkloadVolume	default []
resources	NodeWorkloadResources	default {}
restart	string	one of "no", "always", "unless-stopped" · default "unless-stopped"
health	NodeWorkloadHealth	default {"type":"process","settleSeconds":5}
command	array of string
diagnostics	object
probes	map of array of string	default {}
{key}	array of string	1 to 32 items
ingress	NodeWorkloadIngress
jobs	array of object	default []
idrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
sourcerequired	object
repository	string
revisionrequired	string	1 to 64 characters
build	string	one of "registry", "local" · default "registry"
registry	NodeWorkloadRegistryRef
imagerequired	string
commandrequired	array of string	1 to 64 items
env	map of string	default {}
{key}	string	up to 4096 characters
volumes	array of NodeWorkloadVolume	default []
resources	NodeWorkloadResources	default {}
timeoutSeconds	integer	1 to 86400 · default 3600
retainRuns	integer	1 to 20 · default 5
trigger	NodeJobTrigger

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
workloadsrequired
Type
array of object
Description
idrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
state
Type
string
Description
one of "running", "stopped" · default "running"
sourcerequired
Type
object
Description
repository
Type
string
Description
revisionrequired
Type
string
Description
1 to 64 characters
build
Type
string
Description
one of "registry", "local" · default "registry"
registry
Type
NodeWorkloadRegistryRef
Description
imagerequired
Type
string
Description
env
Type
map of string
Description
default {}
{key}
Type
string
Description
up to 4096 characters
volumes
Type
array of NodeWorkloadVolume
Description
default []
resources
Type
NodeWorkloadResources
Description
default {}
restart
Type
string
Description
one of "no", "always", "unless-stopped" · default "unless-stopped"
health
Type
NodeWorkloadHealth
Description
default {"type":"process","settleSeconds":5}
command
Type
array of string
Description
diagnostics
Type
object
Description
probes
Type
map of array of string
Description
default {}
{key}
Type
array of string
Description
1 to 32 items
ingress
Type
NodeWorkloadIngress
Description
jobs
Type
array of object
Description
default []
idrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
sourcerequired
Type
object
Description
repository
Type
string
Description
revisionrequired
Type
string
Description
1 to 64 characters
build
Type
string
Description
one of "registry", "local" · default "registry"
registry
Type
NodeWorkloadRegistryRef
Description
imagerequired
Type
string
Description
commandrequired
Type
array of string
Description
1 to 64 items
env
Type
map of string
Description
default {}
{key}
Type
string
Description
up to 4096 characters
volumes
Type
array of NodeWorkloadVolume
Description
default []
resources
Type
NodeWorkloadResources
Description
default {}
timeoutSeconds
Type
integer
Description
1 to 86400 · default 3600
retainRuns
Type
integer
Description
1 to 20 · default 5
trigger
Type
NodeJobTrigger
Description

NodeCommand

NodeCommand
Field	Type	Description
idrequired	string
kindrequired	string	one of "reconcile", "restart", "redeploy", "logs", "diagnose", "secret", "update", "reboot", "shutdown", "run"
arguments	map of any	default {}
{key}	any
issuedAtrequired	string, date-time
issuedByrequired	string

idrequired
Type
string
Description
kindrequired
Type
string
Description
one of "reconcile", "restart", "redeploy", "logs", "diagnose", "secret", "update", "reboot", "shutdown", "run"
arguments
Type
map of any
Description
default {}
{key}
Type
any
Description
issuedAtrequired
Type
string, date-time
Description
issuedByrequired
Type
string
Description

NodeCommandRecord

NodeCommandRecord
Field	Type	Description
idrequired	string
kindrequired	string	one of "reconcile", "restart", "redeploy", "logs", "diagnose", "secret", "update", "reboot", "shutdown", "run"
arguments	map of any	default {}
{key}	any
issuedAtrequired	string, date-time
issuedByrequired	string
staterequired	string	one of "pending", "done", "failed"
ackedAtrequired	string, date-time, or null
detailrequired	string, or null
outputrequired	string, or null

idrequired
Type
string
Description
kindrequired
Type
string
Description
one of "reconcile", "restart", "redeploy", "logs", "diagnose", "secret", "update", "reboot", "shutdown", "run"
arguments
Type
map of any
Description
default {}
{key}
Type
any
Description
issuedAtrequired
Type
string, date-time
Description
issuedByrequired
Type
string
Description
staterequired
Type
string
Description
one of "pending", "done", "failed"
ackedAtrequired
Type
string, date-time, or null
Description
detailrequired
Type
string, or null
Description
outputrequired
Type
string, or null
Description

NodeSealedSecret

NodeSealedSecret
Field	Type	Description
vrequired	number	one of 1
keyrequired	string	up to 64 characters
epkrequired	string	up to 64 characters
noncerequired	string	up to 32 characters
ctrequired	string	up to 24000 characters

vrequired
Type
number
Description
one of 1
keyrequired
Type
string
Description
up to 64 characters
epkrequired
Type
string
Description
up to 64 characters
noncerequired
Type
string
Description
up to 32 characters
ctrequired
Type
string
Description
up to 24000 characters

IssueNodeCommand

one of object, object, object, object, object, object, object, object, object, object

NodeTunnelToken

NodeTunnelToken
Field	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
tunnelIdrequired	string
tokenrequired	string

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
tunnelIdrequired
Type
string
Description
tokenrequired
Type
string
Description

NodeRunRecord

NodeRunRecord
Field	Type	Description
runIdrequired	string	1 to 64 characters
revisionrequired	string	1 to 128 characters
staterequired	string	one of "running", "succeeded", "failed", "timed-out"
exitCoderequired	integer, or null
startedAtrequired	string, date-time, or null
finishedAtrequired	string, date-time, or null
detailrequired	string	up to 1024 characters
jobIdrequired	string	1 to 63 characters
recordedAtrequired	string, date-time

runIdrequired
Type
string
Description
1 to 64 characters
revisionrequired
Type
string
Description
1 to 128 characters
staterequired
Type
string
Description
one of "running", "succeeded", "failed", "timed-out"
exitCoderequired
Type
integer, or null
Description
startedAtrequired
Type
string, date-time, or null
Description
finishedAtrequired
Type
string, date-time, or null
Description
detailrequired
Type
string
Description
up to 1024 characters
jobIdrequired
Type
string
Description
1 to 63 characters
recordedAtrequired
Type
string, date-time
Description

NodeTriggerMatch

NodeTriggerMatch
Field	Type	Description
nodeIdrequired	string
jobIdrequired	string
outcomerequired	string	one of "queued", "issued", "ignored"
detailrequired	string

nodeIdrequired
Type
string
Description
jobIdrequired
Type
string
Description
outcomerequired
Type
string
Description
one of "queued", "issued", "ignored"
detailrequired
Type
string
Description

NodeTriggerResult

NodeTriggerResult
Field	Type	Description
dedupedrequired	boolean
ignoredrequired	string, or null
matchedrequired	array of NodeTriggerMatch
nodeIdrequired	string
jobIdrequired	string
outcomerequired	string	one of "queued", "issued", "ignored"
detailrequired	string

dedupedrequired
Type
boolean
Description
ignoredrequired
Type
string, or null
Description
matchedrequired
Type
array of NodeTriggerMatch
Description
nodeIdrequired
Type
string
Description
jobIdrequired
Type
string
Description
outcomerequired
Type
string
Description
one of "queued", "issued", "ignored"
detailrequired
Type
string
Description

NodeGithubPush

NodeGithubPush
Field	Type	Description
deliveryIdrequired	string	1 to 128 characters
repositoryrequired	string	1 to 255 characters
refrequired	string	1 to 1024 characters
commitrequired	string	1 to 128 characters
pusher	string	up to 128 characters · default ""

deliveryIdrequired
Type
string
Description
1 to 128 characters
repositoryrequired
Type
string
Description
1 to 255 characters
refrequired
Type
string
Description
1 to 1024 characters
commitrequired
Type
string
Description
1 to 128 characters
pusher
Type
string
Description
up to 128 characters · default ""

NodePendingTrigger

NodePendingTrigger
Field	Type	Description
nodeIdrequired	string
jobIdrequired	string
commitrequired	string
refrequired	string
generationrequired	integer
actorrequired	string
pusherrequired	string
queuedAtrequired	string, date-time
commandIdrequired	string, or null

nodeIdrequired
Type
string
Description
jobIdrequired
Type
string
Description
commitrequired
Type
string
Description
refrequired
Type
string
Description
generationrequired
Type
integer
Description
actorrequired
Type
string
Description
pusherrequired
Type
string
Description
queuedAtrequired
Type
string, date-time
Description
commandIdrequired
Type
string, or null
Description

NodeReleaseAsset

NodeReleaseAsset
Field	Type	Description
assetIdrequired	integer
namerequired	string
sizerequired	integer	at least 0
sha256required	string, or null
targetrequired	string, or null

assetIdrequired
Type
integer
Description
namerequired
Type
string
Description
sizerequired
Type
integer
Description
at least 0
sha256required
Type
string, or null
Description
targetrequired
Type
string, or null
Description

NodeRelease

NodeRelease
Field	Type	Description
tagrequired	string
namerequired	string
publishedAtrequired	string, or null
prereleaserequired	boolean
assetsrequired	array of NodeReleaseAsset
assetIdrequired	integer
namerequired	string
sizerequired	integer	at least 0
sha256required	string, or null
targetrequired	string, or null

tagrequired
Type
string
Description
namerequired
Type
string
Description
publishedAtrequired
Type
string, or null
Description
prereleaserequired
Type
boolean
Description
assetsrequired
Type
array of NodeReleaseAsset
Description
assetIdrequired
Type
integer
Description
namerequired
Type
string
Description
sizerequired
Type
integer
Description
at least 0
sha256required
Type
string, or null
Description
targetrequired
Type
string, or null
Description

UpdateNodeFromRelease

UpdateNodeFromRelease
Field	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
version	string	1 to 128 characters
platform	string	1 to 64 characters
assetId	integer

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
version
Type
string
Description
1 to 128 characters
platform
Type
string
Description
1 to 64 characters
assetId
Type
integer
Description

NodeAuditEvent

NodeAuditEvent
Field	Type	Description
idrequired	string
actorrequired	string
actionrequired	string	one of "node.registered", "desired.updated", "command.issued", "tunnel.token.revealed", "tunnel.token.sent", "job.triggered", "job.trigger.dropped"
targetTyperequired	string	one of "node"
targetIdrequired	string
targetLabelrequired	string, or null
atrequired	string, date-time
detailrequired	string, or null

idrequired
Type
string
Description
actorrequired
Type
string
Description
actionrequired
Type
string
Description
one of "node.registered", "desired.updated", "command.issued", "tunnel.token.revealed", "tunnel.token.sent", "job.triggered", "job.trigger.dropped"
targetTyperequired
Type
string
Description
one of "node"
targetIdrequired
Type
string
Description
targetLabelrequired
Type
string, or null
Description
atrequired
Type
string, date-time
Description
detailrequired
Type
string, or null
Description

NodeDesiredState

NodeDesiredState
Field	Type	Description
generationrequired	integer	at least 0
workloadsrequired	array of NodeWorkload
idrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
state	string	one of "running", "stopped" · default "running"
sourcerequired	NodeWorkloadSource
env	map of string	default {}
{key}	string	up to 4096 characters
volumes	array of NodeWorkloadVolume	default []
resources	NodeWorkloadResources	default {}
restart	string	one of "no", "always", "unless-stopped" · default "unless-stopped"
health	NodeWorkloadHealth	default {"type":"process","settleSeconds":5}
command	array of string
diagnostics	object
probes	map of array of string	default {}
{key}	array of string	1 to 32 items
ingress	NodeWorkloadIngress
tunnel	object
imagerequired	string
revisionrequired	string
jobs	array of NodeJob	default []
idrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
sourcerequired	NodeWorkloadSource
commandrequired	array of string	1 to 64 items
env	map of string	default {}
{key}	string	up to 4096 characters
volumes	array of NodeWorkloadVolume	default []
resources	NodeWorkloadResources	default {}
timeoutSeconds	integer	1 to 86400 · default 3600
retainRuns	integer	1 to 20 · default 5
trigger	NodeJobTrigger

generationrequired
Type
integer
Description
at least 0
workloadsrequired
Type
array of NodeWorkload
Description
idrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
state
Type
string
Description
one of "running", "stopped" · default "running"
sourcerequired
Type
NodeWorkloadSource
Description
env
Type
map of string
Description
default {}
{key}
Type
string
Description
up to 4096 characters
volumes
Type
array of NodeWorkloadVolume
Description
default []
resources
Type
NodeWorkloadResources
Description
default {}
restart
Type
string
Description
one of "no", "always", "unless-stopped" · default "unless-stopped"
health
Type
NodeWorkloadHealth
Description
default {"type":"process","settleSeconds":5}
command
Type
array of string
Description
diagnostics
Type
object
Description
probes
Type
map of array of string
Description
default {}
{key}
Type
array of string
Description
1 to 32 items
ingress
Type
NodeWorkloadIngress
Description
tunnel
Type
object
Description
imagerequired
Type
string
Description
revisionrequired
Type
string
Description
jobs
Type
array of NodeJob
Description
default []
idrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
sourcerequired
Type
NodeWorkloadSource
Description
commandrequired
Type
array of string
Description
1 to 64 items
env
Type
map of string
Description
default {}
{key}
Type
string
Description
up to 4096 characters
volumes
Type
array of NodeWorkloadVolume
Description
default []
resources
Type
NodeWorkloadResources
Description
default {}
timeoutSeconds
Type
integer
Description
1 to 86400 · default 3600
retainRuns
Type
integer
Description
1 to 20 · default 5
trigger
Type
NodeJobTrigger
Description

AckNodeCommand

AckNodeCommand
Field	Type	Description
nodeIdrequired	string	1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$\|^[a-z0-9]$
commandIdrequired	string	1 to 64 characters
outcomerequired	string	one of "done", "failed"
detail	string	up to 2000 characters · default ""
output	string, or null	up to 200000 characters · default null

nodeIdrequired
Type
string
Description
1 to 63 characters · matches ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
commandIdrequired
Type
string
Description
1 to 64 characters
outcomerequired
Type
string
Description
one of "done", "failed"
detail
Type
string
Description
up to 2000 characters · default ""
output
Type
string, or null
Description
up to 200000 characters · default null