Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <api_key>. The legacy Authorization: Api-Key <api_key> scheme is also accepted.

Path Parameters

volume_namespace
string
required
volume_name
string
required
volume_version
string
required

Response

200 - application/json

One version, with the fields only a single-version read reports.

namespace
string
required

Namespace the volume belongs to, in lowercase.

volume
string
required

Name of the volume, in lowercase.

version_ref
string
required

Full address of this version, as bdn:<namespace>/<volume>@<digest>. Paste this into the bdn.mounts section of a config.yaml to pin to it.

digest
string
required

Content digest of the version, as b3:<hex>.

sequence
integer | null
required

Revision the version was committed at. Null for versions committed before the volume service recorded it.

lifecycle
string
required

Lifecycle state of the version, for example ALIVE or TOMBSTONED.

is_head
boolean
required

Whether the reserved head tag points at this version.

tags
string[]
required

Tags pointing at this version that your API key can read.

total_size_bytes
integer | null
required

Total size of the version's files in bytes. Null when not recorded.

created_at
string<date-time>
required

When the version was committed, in ISO 8601 format.

tombstoned_at
string<date-time> | null
required

When the version was deleted, in ISO 8601 format. Null unless the lifecycle is TOMBSTONED.

delete_after
string<date-time> | null
required

When the version stops being restorable, in ISO 8601 format. Null unless the lifecycle is TOMBSTONED.

entry_count
integer | null
required

Number of files in the version. Null when not recorded.

volume_sequence
integer
required

Revision of the volume as a whole when this version was read. Pass it as expected_sequence on a later delete to make that delete conditional on the volume not having changed since.