Get the cluster agent
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)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/org/clusters/imported/{cluster_id}/agent', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/org/clusters/imported/{cluster_id}/agent \
--header 'Authorization: Bearer <token>'{
"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
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Imported Clusters
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
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)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/org/clusters/imported/{cluster_id}/agent', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/org/clusters/imported/{cluster_id}/agent \
--header 'Authorization: Bearer <token>'{
"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
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Response
Successful Response
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.