import requests
url = "https://platform.ankra.app/api/v1/clusters/ankracloud/{cluster_id}/os-patches/policy"
payload = {
"enabled": True,
"window_days": ["<string>"],
"window_start_hour_utc": 123,
"window_duration_hours": 123,
"cadence_days": 123,
"include_stateful_nodes": True,
"security_lag_days": 123
}
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({
enabled: true,
window_days: ['<string>'],
window_start_hour_utc: 123,
window_duration_hours: 123,
cadence_days: 123,
include_stateful_nodes: true,
security_lag_days: 123
})
};
fetch('https://platform.ankra.app/api/v1/clusters/ankracloud/{cluster_id}/os-patches/policy', 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/clusters/ankracloud/{cluster_id}/os-patches/policy \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enabled": true,
"window_days": [
"<string>"
],
"window_start_hour_utc": 123,
"window_duration_hours": 123,
"cadence_days": 123,
"include_stateful_nodes": true,
"security_lag_days": 123
}
'{
"enabled": true,
"window": {
"days": [
"<string>"
],
"start_hour_utc": 123,
"duration_hours": 123
},
"cadence_days": 123,
"include_stateful_nodes": true,
"security_lag_days": 123,
"stored": true,
"window_description": "<string>",
"window_open_now": true,
"next_window_opens_utc": "2023-11-07T05:31:56Z",
"hold_revert": {
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"not_started": "<string>"
},
"message": "<string>"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "Cluster not found"
}Update the OS patch policy
Changes the cluster’s OS patch policy: automatic patching on or off, the UTC maintenance window, the cadence, stateful nodes and the security-lag threshold. A member the body omits or sends as null keeps its stored value; an out-of-bounds value answers 409 and changes nothing. Turning the policy off removes the update hold from every host, and is refused while a run is in flight. Answers 404 while the organisation’s ankra_cloud_provider feature flag is off.
import requests
url = "https://platform.ankra.app/api/v1/clusters/ankracloud/{cluster_id}/os-patches/policy"
payload = {
"enabled": True,
"window_days": ["<string>"],
"window_start_hour_utc": 123,
"window_duration_hours": 123,
"cadence_days": 123,
"include_stateful_nodes": True,
"security_lag_days": 123
}
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({
enabled: true,
window_days: ['<string>'],
window_start_hour_utc: 123,
window_duration_hours: 123,
cadence_days: 123,
include_stateful_nodes: true,
security_lag_days: 123
})
};
fetch('https://platform.ankra.app/api/v1/clusters/ankracloud/{cluster_id}/os-patches/policy', 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/clusters/ankracloud/{cluster_id}/os-patches/policy \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enabled": true,
"window_days": [
"<string>"
],
"window_start_hour_utc": 123,
"window_duration_hours": 123,
"cadence_days": 123,
"include_stateful_nodes": true,
"security_lag_days": 123
}
'{
"enabled": true,
"window": {
"days": [
"<string>"
],
"start_hour_utc": 123,
"duration_hours": 123
},
"cadence_days": 123,
"include_stateful_nodes": true,
"security_lag_days": 123,
"stored": true,
"window_description": "<string>",
"window_open_now": true,
"next_window_opens_utc": "2023-11-07T05:31:56Z",
"hold_revert": {
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"not_started": "<string>"
},
"message": "<string>"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "Cluster not found"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
PAT organisation override.
Path Parameters
Body
Response
Successful response
The stored policy after a change, and what became of the update hold when the change turned it off.
Whether the window loop starts runs on its own.
A recurring maintenance window in UTC, opening on each day at start_hour_utc.
Show child attributes
Show child attributes
Minimum days between two automatic runs.
Whether a run drains nodes carrying single-replica stateful workloads.
Days held-back security updates may stay pending before the cluster reports a lag.
False when nobody configured the cluster and the default policy applies.
The removal of the node OS update hold, with the operation that carries it or why none started.
Show child attributes
Show child attributes