Skip to main content
API Explorer|API Explorer
Infrastructure/Agents
GETAgentSince 1.0SynchronousAuth Required

ListByLifecycleStatus

List agents filtered by their current lifecycle status with snapshot details

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • statusStringRequired

    Lifecycle status filter (online, offline, upgrading, delayed)

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    Collection of result items

    Example: (nested array)

    • agentIdString

      UUID of the agent captured in this snapshot

      Example: agent-abc123-def456

    • statusString

      Current lifecycle status of the agent

      Example: online

    • currentVersionString

      Currently running version of the agent

      Example: 1.4.2

    • lastHeartbeatString

      Last heartbeat

      Example: 2026-01-15T08:00:00Z

  • totalInteger

    Total number of agents with the given lifecycle status

    Example: 75

  • limitInteger

    Maximum number of snapshots returned

    Example: 20

  • offsetInteger

    Number of snapshots skipped for pagination

    Example: 20

Endpoint

GET/api/v1/agents/by-lifecycle-status/{status}

/api/v1/agents/by-lifecycle-status/{status}

Operation ID

ListByLifecycleStatus

Permalink

Request Example

curl -X GET '{host}/api/v1/agents/by-lifecycle-status/{status}' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "items": [
    {}
  ],
  "total": 75,
  "limit": 20,
  "offset": 20
}

Change History

This API has no change history records yet.

View all change history