Checkpoint
The checkpoint API can be used to list and restore checkpoints created in a flow.
List Checkpoints
You can access a paginated list of checkpoints for a specific process,
identified by the id, with the REST API.
The
/api/v1/process/{id}/checkpointendpoint is deprecated since version 2.44.0 in favor of the paginated/api/v3endpoint described below.
- URI
/api/v3/process/{id}/checkpoint - Method
GET - Headers
Authorization,Content-Type: application/json - Query parameters
offset- number of checkpoints to skip; defaults to0limit- maximum number of checkpoints to return; defaults to10
-
Body none
-
Success response
Content-Type: application/json[ { "id": "...", "name": "...", "createdAt": "..." }, { "id": "...", "name": "...", "createdAt": "..." }, ... ]
Restore a Process
You can restore a process state from a named checkpoint of a specific process using the process identifier in the URL and the checkpoint identifier in the body.
- URI
/api/v1/process/{id}/checkpoint/restore - Method
POST - Headers
Authorization,Content-Type: application/json - Body
{ "id": "..." } -
Success response
Content-Type: application/json{ "ok": true }
