The checkpoint API can be used to list and restore checkpoints created in a flow.
You can access a list of all checkpoints for a specific process, identified by
the id
, with the REST API.
/api/v1/process/{id}/checkpoint
GET
Authorization
, Content-Type: application/json
Body none
Success response
Content-Type: application/json
[
{
"id": "...",
"name": "...",
"createdAt": "..."
},
{
"id": "...",
"name": "...",
"createdAt": "..."
},
...
]
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.
/api/v1/process/{id}/checkpoint/restore
POST
Authorization
, Content-Type: application/json
{
"id": "..."
}
Success response
Content-Type: application/json
{
"ok": true
}