Skip to main content
POST
Create an object storage bucket

Authorizations

Authorization
string
header
required

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

Headers

x-ankra-organisation-id
string

PAT organisation override.

Body

application/json
credential_id
string<uuid>
required

One of the organisation's provider credentials; its provider decides where the bucket is created.

name
string
required

A lowercase label such as registry-storage, unique in the organisation.

region
string
required

The provider region, such as fsn1 (Hetzner), fr-par (Scaleway), fra1 (DigitalOcean) or europe-1 (UpCloud).

access_key_id
string

Hetzner only: the Object Storage access key, issued in the Hetzner Cloud Console. Omit it when the pair is stored on the Hetzner credential.

bucket
string

The provider-side bucket name. Derived from name when omitted.

secret_access_key
string

Hetzner only: the secret half of the Object Storage key pair.

Response

Accepted: the bucket is being provisioned

An object storage bucket Ankra created on one of the organisation's provider credentials. Key material is never part of it.

bucket
string
required

The provider-side bucket name.

created_at
string<date-time>
required
credential_id
string<uuid>
required

The provider credential the bucket was created with.

endpoint
string
required

The S3 endpoint. Empty until provisioning knows it (an UpCloud endpoint exists only once its service does).

id
string<uuid>
required
name
string
required

The Ankra-side name, unique in the organisation.

path_style
boolean
required
provider
enum<string>
required
Available options:
hetzner,
scaleway,
digitalocean,
upcloud
region
string
required
status
enum<string>
required
Available options:
provisioning,
ready,
error
updated_at
string<date-time>
required
error_excerpt
string

Why provisioning or a teardown failed; present only in error.