Developer portal
GET /tenant/discovery/agents
List enrolled host agents with heartbeat and findings counts.
GET /tenant/discovery/agentsAuth: viewer | operator | admin
Summary
List enrolled host agents with heartbeat and findings counts.
Example
Response
{
"status": "success",
"agents": [
{
"agentId": "agent-1",
"status": "online"
}
]
}Try it live
Paste your tenant API key to call the live API with your credentials. Leave blank to use the public sandbox key when configured, or click “Show example response” for the static fixture below.
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| fleetId | string | No | Filter by fleet. |
Response
| Field | Type | Required | Description |
|---|---|---|---|
| agents | object[] | Yes | Agent rows with status and lastSeenAt. |
Errors
| Code | Meaning | Typical cause | Suggested fix |
|---|---|---|---|
| 401 | Unauthorized | Missing or invalid API key in Authorization, x-api-key, or query param. | Send Bearer <key> or x-api-key with a valid tenant token. |
| 403 | Forbidden | Valid key but insufficient role (viewer attempting write) or wrong admin key. | Use operator or admin role key; check RBAC matrix. |
| 404 | Not found | Scan, schedule, share link, or resource id does not exist or expired. | Verify id and tenant scope; share links expire per expiresHours. |
| 422 | Unprocessable entity | Invalid payload shape, unsupported scenario, or infeasible constraints. | Fix field errors in response detail; relax constraints and retry. |
| 429 | Too many requests | Per-key rate limit exceeded (default 300 requests per minute) or public endpoint limit. | Backoff with jitter; cache results; request higher limit for production. |
| 500 | Internal server error | Unexpected backend failure; includes requestId in response. | Retry with exponential backoff; contact support with requestId if persistent. |
| 503 | Service unavailable | Persistence disabled, auth DB unreachable, or admin API not configured. | Retry shortly; schedules require Postgres persistence enabled. |
See the full errors reference.
Found an issue? Report documentation feedback