Skip to main content
GET
Get agent status

Headers

X-API-Key
string | null

Path Parameters

agent_id
string
required

The agent's unique identifier. Accepts either the internal UUID (returned as id by the Provision agent operation) or the external ID (external_id).

Response

Successful Response

result
AgentStatusResponse · object
required

Agent status payload used by /principals/{id}/status.

success
boolean
default:true
suggestion
string
default:""
message
string
default:""
meta
PaginationMeta · object | null

Pagination metadata for list responses.

Supports both legacy offset-based and cursor-based pagination. Cursor fields (has_more, after, before) are populated for cursor-paginated endpoints. Legacy fields (offset, limit) are populated when the caller uses the deprecated offset parameter.