Get the cluster agent

Returns the cluster agent’s version, whether it is online, when it last checked in, and its upgrade state, including whether automatic upgrades are turned off. Answers 404 when no agent is registered.

GET /api/v1/org/clusters/imported/{cluster_id}/agent

Get the cluster agent

Python

import requests

url = "https://platform.ankra.app/api/v1/org/clusters/imported/{cluster_id}/agent"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "created_at": "2023-11-07T05:31:56Z",
  "upgrade_available": true,
  "upgrading": true,
  "agent_version": "<string>",
  "checked_in_at": "2023-11-07T05:31:56Z",
  "disable_auto_upgrade": false,
  "latest_agent_version": "<string>",
  "nats_grant": "scoped",
  "nats_scoped_inbox": true,
  "security_upgrade_required": true
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization · string | null

x-ankra-organisation-id · string | null

Path Parameters

cluster_id · string<uuid4> · required

Response

200

application/json

Successful Response

created_at · string<date-time> · required

upgrade_available · boolean · required

upgrading · boolean · required

agent_version · string | null

checked_in_at · string<date-time> | null

disable_auto_upgrade · boolean · default: false

latest_agent_version · string | null

nats_grant · enum<string> | null

The NATS grant the agent's credential was recorded holding at its last identify: scoped is the least-privilege grant, legacy the wildcard grant being retired. Null when the agent has not identified since the platform began recording it.

Available options: scoped, legacy

nats_scoped_inbox · boolean | null

Whether the agent advertised nats_scoped_inbox at its last identify, which is what earns it the least-privilege grant. An agent that identified without the capability is false; null only when it has never identified.

security_upgrade_required · boolean | null

True when the agent holds the legacy grant or does not advertise nats_scoped_inbox: it must be upgraded before the legacy grant is switched off, or its command lane goes dark. False only when the scoped grant is recorded and the capability advertised. Null when the recorded facts cannot decide it - never false by default.