Swarm Nodes

REST endpoints for swarm nodes. Bearer-auth required.

GET /api/swarm-nodes

List swarm nodes for a swarm version.

Query parameters

• limit (optional): Page size (1–100, default 100).
• after (optional): Keyset cursor — return the page after this row (next page).
• before (optional): Keyset cursor — return the page before this row (prev page).
• ids (optional): Comma-separated list of IDs. Narrows results to these IDs within the caller's accessible scope (does not bypass access checks).
• filter (optional): Nested filter expression (<Entity>Filter): AND/OR/NOT + per-field comparison operators + relation traversal. JSON-encoded on the query string.
• orderBy (optional): Multi-key sort (<Entity>OrderBy[]): array of { field: direction } applied in order. Directions: asc/desc plus the four explicit nulls variants. JSON-encoded on the query string.
• swarm_version_id (required): Swarm version whose nodes to list.
• agent_id (optional): Shorthand: filter where agentId equals this value.
• agent_version_id (optional): Shorthand: filter where agentVersionId equals this value.

Response

{
  "data": [
    {
      "id": "<...>",
      "swarmVersionId": "<...>",
      "agentId": "<...>",
      "agentVersionId": "<...>"
    }
  ]
}

POST /api/swarm-nodes

Add a node to a swarm version

Request body

{
  "swarmVersionId": "string",
  "agentId": "string",
  "agentVersionId?": "string"
}

Response

{
  "id": "string",
  "swarmVersionId": "string",
  "agentId": "string",
  "agentVersionId": "string"
}

GET /api/swarm-nodes/{id}

Get a swarm node by ID.

Path parameters

• id (required): Node to retrieve.

Response

{
  "id": "string",
  "swarmVersionId": "string",
  "agentId": "string",
  "agentVersionId": "string"
}

DELETE /api/swarm-nodes/{id}

Delete a swarm node.

Path parameters

• id (required): Node to remove.

Response

{
  "success": "boolean"
}