Skip to main content
GET
Get 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.

Path Parameters

bucket_id
string<uuid>
required

The bucket's id.

Response

Successful response

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.