v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB

Agents

List All Agents

Lists All Agents, including summary details for each Agent

get/v1/agents

Query parameters

{"stackTrail":"paths:/v1/agents:get:parameters:0:schema","oasType":"schema","type":"unknown"}

Page number (0-indexed)

{"stackTrail":"paths:/v1/agents:get:parameters:1:schema","oasType":"schema","type":"unknown"}

Number of records per page (from 1 to 100)

Response

Success

pageinteger

The 0-indexed page number of the returned results.

sizeinteger

The size of each page of results.

totalinteger

Total number of available results across all pages.

Example response

{
  "page": 1,
  "results": [
    {
      "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "agentStatus": "running",
      "agentType": "data_productivity_cloud",
      "cloudProvider": "aws",
      "connected": true,
      "deployment": "fargate",
      "description": "An AWS Agent",
      "name": "AWS Agent",
      "pausedUntil": "2025-01-01T00:00:00.000Z"
    }
  ],
  "size": 50,
  "total": 472
}