Skip to main content
Get a volume checkpoint

Authorizations

Authorization
string
header
required

BoxRouter API key; never an upstream provider key.

Path Parameters

volume_id
string
required

BoxRouter-managed Volume ID. Provider-native volume requirements are not accepted.

Pattern: ^vol_[0-9a-f]{32}$
checkpoint
integer
required
Required range: x >= 1

Response

Volume checkpoint

An immutable saved filesystem checkpoint identified by (volume_id, checkpoint). Observed volume bytes are whole-disk measurements taken before the save, not per-checkpoint sizes. Deleting or expiring its API reference does not reclaim backend disk bytes; those remain until the volume is erased.

volume_id
string
required

BoxRouter-managed Volume ID. Provider-native volume requirements are not accepted.

Pattern: ^vol_[0-9a-f]{32}$
checkpoint
integer
required
Required range: x >= 1
state
enum<string>
required

Only committed checkpoints are listed; a save in progress is not a checkpoint.

Available options:
ready
created_at
string<date-time>
required
reason
enum<string>
required

requested is a save call; destroy and pause are saves BoxRouter made first.

Available options:
requested,
destroy,
pause
saved_on
object
required
image
object
required
arch
enum<string>
required
Available options:
amd64,
arm64
user
object
required
path
string
required
Pattern: ^/[^\u0000]*$
observed_volume_bytes
integer | null
required

Whole-volume disk usage observed before this checkpoint was created. May include other retained checkpoints and concurrent writes; not an exact checkpoint size or billing amount.

Required range: x >= 0
duration_ms
integer
required

Save wall time measured by BoxRouter.

Required range: x >= 0
message
string | null
required
Maximum string length: 500