import requests
url = "https://platform.ankra.app/api/v1/org/backup-vaults/provision"
payload = {
"name": "<string>",
"credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"region": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
credential_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
region: '<string>'
})
};
fetch('https://platform.ankra.app/api/v1/org/backup-vaults/provision', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://platform.ankra.app/api/v1/org/backup-vaults/provision \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"region": "<string>"
}
'{
"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"
}Provision a backup vault
Has Ankra create a bucket with an organisation cloud credential and register it as a vault. Answers 202 with the vault in provisioning; the bucket is created in the background and the vault moves to ready or error. Requires backups.manage.
import requests
url = "https://platform.ankra.app/api/v1/org/backup-vaults/provision"
payload = {
"name": "<string>",
"credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"region": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
credential_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
region: '<string>'
})
};
fetch('https://platform.ankra.app/api/v1/org/backup-vaults/provision', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://platform.ankra.app/api/v1/org/backup-vaults/provision \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"region": "<string>"
}
'{
"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.
Body
An Ankra-provisioned vault: Ankra creates the bucket with the named credential.
The organisation cloud credential the bucket is created with; it decides the provider.
Absent places the vault in the caller's current project, null makes it organisation-wide, a UUID names a project of the organisation.
Optional bucket name; a unique one is derived from the vault name when omitted.
Required for Hetzner only, refused elsewhere.
Required for Hetzner only, refused elsewhere.
Response
The vault, in provisioning.
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.