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

Response

200 - application/json
namespace
string
required

Namespace the volume belongs to, in lowercase.

name
string
required

Name of the volume, in lowercase.

version_ref
string
required

Full address of the volume, as bdn:<namespace>/<volume>. Paste this into the bdn.mounts section of a config.yaml.

sequence
integer
required

Revision counter for the volume, incremented on every commit and tag change. Use it to detect that a volume changed.

updated_at
string<date-time>
required

When the volume last changed, in ISO 8601 format.

head
VolumeVersionSummaryV1 · object | null
required

Version that the reserved head tag points at, which a reference with no tag or digest resolves to. Null when the volume has no head, or when your API key cannot read it.

tags
VolumeTagV1 · object[]
required

Tags on the volume that your API key can read.

tag_count
integer
required

Total number of tags on the volume, which can exceed the length of tags when your API key cannot read all of them.

versions_alive
integer
required

Number of versions that have not been deleted.

versions_tombstoned
integer
required

Number of versions that have been deleted.

versions_untagged
integer
required

Number of versions that no tag points at.