Sign in
Agent

List agents

Lists agents within an organization.

get/controlplane/agent

Query parameters

organization_idinteger

The ID of the organization.

account_idinteger

The ID of the account.

nrnstring

Filter agents by a specific NRN.

status'active' | 'inactive'

Status of the scope.

tagsstring

Object containing key-value pairs representing tags to be matched for applying the configuration.

Response

The list of agents matching the query.

Example response

{
  "paging": {
    "limit": 200
  },
  "results": [
    {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "name": "my-agent-name",
      "nrns": [
        "organization=1:account=2",
        "organization=1:account=2:namespace=3"
      ],
      "last_heartbeat": "2021-01-02T00:00:00Z",
      "runtime": "k8s",
      "version": "1.0.0",
      "status": "active",
      "created_at": "2021-01-02T00:00:00Z",
      "updated_at": "2021-01-02T00:00:00Z",
      "capabilities": [
        {
          "id": "commandexecutor1",
          "status": "active",
          "version": "1.0.0",
          "configuration_id": "config1",
          "desired_configuration_id": "desired_config1",
          "is_default_configuration": true,
          "current_configuration_expires_at": "2024-07-12T15:00:00Z",
          "provider": "commandexecutor1",
          "category": "executor1",
          "created_at": "2021-01-02T00:00:00Z",
          "updated_at": "2021-01-02T00:00:00Z"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.