Get a backup vault
import requests
url = "https://platform.ankra.app/api/v1/org/backup-vaults/{vault_id}"
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/backup-vaults/{vault_id}', 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/backup-vaults/{vault_id} \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"kind": "<string>",
"provider": "<string>",
"endpoint": "<string>",
"region": "<string>",
"bucket": "<string>",
"path_style": true,
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"error_excerpt": "<string>",
"last_verified_at": "2023-11-07T05:31:56Z",
"provisioned_via_credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}Backups
Get a backup vault
Reads one backup vault. Requires the backups rollout and backups.read.
GET
/
api
/
v1
/
org
/
backup-vaults
/
{vault_id}
Get a backup vault
import requests
url = "https://platform.ankra.app/api/v1/org/backup-vaults/{vault_id}"
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/backup-vaults/{vault_id}', 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/backup-vaults/{vault_id} \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"kind": "<string>",
"provider": "<string>",
"endpoint": "<string>",
"region": "<string>",
"bucket": "<string>",
"path_style": true,
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"error_excerpt": "<string>",
"last_verified_at": "2023-11-07T05:31:56Z",
"provisioned_via_credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The backup vault.
Response
The vault.
An S3-compatible bucket restore points and imports are kept in. Credentials never leave the server.
customer_s3 for a bring-your-own bucket, ankra_provisioned for one Ankra created.
The vault's lifecycle state, such as provisioning, ready or error.
Why the last verification or provisioning failed.
The organisation credential an Ankra-provisioned vault was created with; absent on a bring-your-own bucket.