Skip to main content
GET
List a backup vault's contents

Authorizations

Authorization
string
header
required

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

Path Parameters

vault_id
string<uuid>
required

The backup vault.

Query Parameters

prefix
string

Walk only this prefix of the bucket.

Maximum string length: 1024
restore_point_id
string

Narrow to one restore point; a unique id prefix is accepted.

Maximum string length: 64
objects
boolean
default:false

Also list the individual objects.

Response

What the bucket holds.

What the vault's bucket actually holds, attributed to restore points, shared repositories and orphans.

vault_id
string<uuid>
required
vault_name
string
required
bucket
string
required
endpoint
string
required
complete
boolean
required

False when the walk hit its ceiling, so the totals are a floor.

orphans_determined
boolean
required

Whether orphans was computed; a narrowed read cannot say nothing is orphaned.

object_count
integer
required
total_bytes
integer<int64>
required
restore_points
object[]
required
shared_repositories
object[]
required
orphans
object[]
required
other
object[]
required
scanned_prefix
string

The scope walked; absent means the whole bucket.

objects
object[]

Individual objects, present only when objects=true.

warnings
string[]