Skip to main content
POST
Create a backup vault

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

A bring-your-own-bucket vault.

name
string
required
endpoint
string
required

The S3 endpoint URL.

bucket
string
required
access_key_id
string
required
secret_access_key
string<password>
required
project_id
string<uuid> | null

Absent places the vault in the caller's current project, null makes it organisation-wide, a UUID names a project of the organisation.

provider
string
region
string
path_style
boolean

Address the bucket path-style rather than virtual-host style.

Response

The new vault.

An S3-compatible bucket restore points and imports are kept in. Credentials never leave the server.

id
string<uuid>
required
name
string
required
kind
string
required

customer_s3 for a bring-your-own bucket, ankra_provisioned for one Ankra created.

provider
string
required
endpoint
string
required
region
string
required
bucket
string
required
path_style
boolean
required
status
string
required

The vault's lifecycle state, such as provisioning, ready or error.

created_at
string<date-time>
required
updated_at
string<date-time>
required
error_excerpt
string

Why the last verification or provisioning failed.

last_verified_at
string<date-time>
provisioned_via_credential_id
string<uuid>

The organisation credential an Ankra-provisioned vault was created with; absent on a bring-your-own bucket.