Skip to main content
GET
Get a checkpoint

Authorizations

Authorization
string
header
required

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

Path Parameters

checkpoint_id
string
required

Response

Success.

checkpoint_id
string
required

Id to pass when starting a Sailbox from this checkpoint.

name
string | null
required

The checkpoint's name, or null if it was not given one.

sailbox_id
string
required

Sailbox the checkpoint was taken from.

app_id
string
required

App of the Sailbox the checkpoint was taken from.

checkpoint_generation
integer<int64>
required

The Sailbox's checkpoint counter as of this checkpoint. It goes up by one every time the Sailbox saves its state, which includes pausing and sleeping.

created_at
string<date-time>
required
expires_at
string<date-time> | null
required

When the checkpoint expires. Starting a Sailbox from it after that fails.