import requests
url = "https://platform.ankra.app/api/v1/org/clusters/imported/{cluster_id}/stacks/{stack_name}/backup-policy"
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}/stacks/{stack_name}/backup-policy', 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}/stacks/{stack_name}/backup-policy \
--header 'Authorization: Bearer <token>'{
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stack_name": "<string>",
"readability": "absent",
"policy": {
"enabled": true,
"vault": "<string>",
"schedule": "<string>",
"resolved_schedule": "<string>",
"retention": {
"hourly": 123,
"daily": 123,
"weekly": 123,
"monthly": 123,
"yearly": 123,
"minimum_count": 123,
"minimum_age": "<string>"
},
"selection": {
"databases": true,
"persistent_volume_claims": [
"<string>"
]
}
},
"stored": "<unknown>",
"next_scheduled_at": "2023-11-07T05:31:56Z",
"vault_name": "<string>",
"fingerprint": "<string>",
"next_scheduled_at_unknown_reason": "policy_absent"
}Get a stack's backup policy
Reads back the backup policy stored on a stack’s definition, decoded, together with the block exactly as stored, its fingerprint and the next scheduled run or why there is none. Branch on readability first. Requires backups.read.
import requests
url = "https://platform.ankra.app/api/v1/org/clusters/imported/{cluster_id}/stacks/{stack_name}/backup-policy"
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}/stacks/{stack_name}/backup-policy', 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}/stacks/{stack_name}/backup-policy \
--header 'Authorization: Bearer <token>'{
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stack_name": "<string>",
"readability": "absent",
"policy": {
"enabled": true,
"vault": "<string>",
"schedule": "<string>",
"resolved_schedule": "<string>",
"retention": {
"hourly": 123,
"daily": 123,
"weekly": 123,
"monthly": 123,
"yearly": 123,
"minimum_count": 123,
"minimum_age": "<string>"
},
"selection": {
"databases": true,
"persistent_volume_claims": [
"<string>"
]
}
},
"stored": "<unknown>",
"next_scheduled_at": "2023-11-07T05:31:56Z",
"vault_name": "<string>",
"fingerprint": "<string>",
"next_scheduled_at_unknown_reason": "policy_absent"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The imported cluster.
The stack's name on the cluster.
Response
The stored policy.
A stack's stored backup policy, read back.
Branch on this first: every field below is empty unless it is present.
absent, present, unreadable The stored policy, decoded; null when absent or unreadable.
Show child attributes
Show child attributes
The stored block exactly as the stack definition holds it.
Digest of the decoded policy, matching the label on the rendered schedule.
Why next_scheduled_at is null; absent whenever it is set.
policy_absent, policy_unreadable, policy_disabled, schedule_unparseable