Skip to main content
POST
Restore data to checkpoint

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>.

Path Parameters

checkpoint_id
string
required

ID of the checkpoint, as checkpoint_id from List data checkpoints.

app_id
string
required

ID of the app.

Body

application/json

Which entities to restore to the checkpoint.

entity_names
string[]
required

Entities to restore, as List entity schemas reports them. Name at least one and at most 300. They don't have to include the entity the checkpoint belongs to.

Example:

Response

The restore started.

The restore that started, and which entities it covers.

batch_id
string
required

ID of the restore. Pass it to Get data restore status to follow it.

Example:

"3f1c9a52-7b4e-4d2a-9c61-5e8f0b7a2d14"

launched
LaunchedRestore · object[]
required

The entities whose restore started, each with the ID of its own part of the restore.

Example:
skipped_entities
string[]
required

Entities you asked for that didn't start, because another restore was already running on them. Try them again once it finishes.

Example: