---
title: "List Agents"
method: GET
path: "/agents"
tags: ["agents"]
---

# List Agents

`GET /agents`

## Query parameters

- `query` string
- `selector` string
- `offset` string
- `limit` string
- `sort` string

## Response `200`

OK

- ModelAgentsResponse
  - `agents` ModelAgent[]
    - `arch` string
    - `available_components_hash` string
    - `configuration` unknown
    - `configurationStatus` ModelConfigurationVersions
      - `assigned` string — Assigned is the configuration that has been assigned to the agent. It may not be rolled out to the agent. Use Current for the configuration actually in use by the Agent. This will be the name of the configuration and will not have a version associated with it.
      - `current` string — Current is the configuration currently applied to the agent.
      - `currentStage` integer — CurrentStage is the stage of the Current configuration
      - `dirty` boolean — Dirty is true if the assigned configuration has been modified but it has not been applied to the agent via Future/Pending/Current.
      - `future` string — Future is the configuration that this agent is scheduled for when a rollout starts. As the rollout progresses, this value becomes Pending and this will be cleared.
      - `futureStage` integer — FutureStage is the stage of the Future configuration
      - `pending` string — Pending is the configuration that OPAMP has been notified via the event bus to apply to this agent. Once this configuration is confirmed, Current will be set to this value and this will be cleared.
      - `pendingSetAt` string
      - `pendingStage` integer — PendingStage is the stage of the Pending configuration
    - `connectedAt` string
    - `disconnectedAt` string
    - `errorMessage` string
    - `features` 1 | 2 | 4 | 8 | 16 | 32 | 64 | 128 | 256 | 512 | 1024 | 2048 | 4096 | 8192 | 16384 | 32768 | 65536 | 257
    - `fleet` string — Fleet is the name of the fleet that the agent is a member of. Because this can be specified by the fleet: label on the agent, it is possible that the fleet with this name does not exist.
    - `fleetStatus` 0 | 1 | 2
    - `hostname` string
    - `id` string
    - `labels` ModelLabels
    - `labels_bootstrapped` boolean — LabelsBootstrapped is true if the labels have been "bootstrapped" (meaning, the initial labels have been set). When this is true, labels in the agent description are not applied. This is set to true after the initial agent labels are set.
    - `macAddress` string
    - `name` string
    - `operatingSystem` string
    - `outOfDate` boolean
    - `pendingLabels` ModelLabels
    - `platform` string
    - `protocol` string
    - `remoteAddress` string
    - `reported_at` string — ReportedAt is the time the agent last reported.
    - `state` unknown
    - `status` 0 | 1 | 2 | 4 | 5 | 6 | 7 | 8 | 9
    - `type` string — Type should match the AgentType of this collector. This value is set from the "service.name" attribute in the OpAMP AgentDescription.
    - `upgrade` ModelAgentUpgrade
      - `allPackagesHash` integer[] — AllPackagesHash is the hash of the packages sent to the agent to upgrade
      - `error` string — Error is set if there were errors upgrading the agent
      - `status` 0 | 1 | 2
      - `version` string — Version is used to indicate that an agent should be or is being upgraded. The agent status will be set to Upgrading when the upgrade begins.
    - `version` string

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.dev/bindplane/apis/docs-bindplane-com.md) · [All operations](https://skmtc.dev/bindplane/apis/docs-bindplane-com/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bindplane/docs-bindplane-com/revisions/bfcb7e57121c/schema)