import requests
url = "https://platform.ankra.app/api/v1/org/clusters/imported/{cluster_id}/agent/settings"
payload = { "disable_auto_upgrade": True }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({disable_auto_upgrade: true})
};
fetch('https://platform.ankra.app/api/v1/org/clusters/imported/{cluster_id}/agent/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request PATCH \
--url https://platform.ankra.app/api/v1/org/clusters/imported/{cluster_id}/agent/settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"disable_auto_upgrade": true
}
'{
"message": "<string>",
"success": true
}{
"detail": "Cluster not found"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Update Cluster Agent Settings Endpoint
Turn the cluster agent’s automatic upgrades on or off. With them on (the default) the platform’s fleet rollout applies each new agent release as soon as the cluster has no write execution running; with them off the rollout skips this agent until they are turned back on, which is how a team fences a cluster off from agent releases for a freeze window. The bearer twin of the portal’s cluster settings switch (ankra cluster agent auto-upgrade enable|disable, MCP set_cluster_agent_auto_upgrade). POST …/agent/upgrade still applies a release on demand whichever way the switch sits.
import requests
url = "https://platform.ankra.app/api/v1/org/clusters/imported/{cluster_id}/agent/settings"
payload = { "disable_auto_upgrade": True }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({disable_auto_upgrade: true})
};
fetch('https://platform.ankra.app/api/v1/org/clusters/imported/{cluster_id}/agent/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request PATCH \
--url https://platform.ankra.app/api/v1/org/clusters/imported/{cluster_id}/agent/settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"disable_auto_upgrade": true
}
'{
"message": "<string>",
"success": true
}{
"detail": "Cluster not found"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
true fences the agent off from the automatic fleet rollout; false puts it back in. Omitted leaves the setting unchanged.