NUnullplatform
Agent

Read an agent

Changed on

Retrieve a specific agent by its ID.

get/controlplane/agent/{id}

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/controlplane/agent/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The unique ID of the agent.

Response

The operation was successful.

idstring required

A system-wide unique ID for the agent.

namestring nullable required

The name of the agent.

nrnsstring[]

List of NRNs the agent is authorized to operate on, derived from the API key permissions.

last_heartbeatstring date-time required

The ISO-8601 UTC timestamp of the last heartbeat from the agent.

runtimestring required

The runtime the agent runs on, for example, k8s or host.

versionstring required

The version of the agent.

tagsobject required

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

status'active' required

The status of the agent.

created_atstring date-time required

The ISO-8601 UTC timestamp of when the agent was created.

updated_atstring date-time nullable

The ISO-8601 UTC timestamp of when the agent was last updated.

Example response

{
  "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

  • 728d4df70ca1Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property message deprecated

    • info

      response property message deprecated

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status