Sign in
Pipeline Lifecycle

Get Checkpoint Status

Required role: read or higher.

Retrieve status of checkpoint activity in a pipeline.

get/v0/pipelines/{pipeline_name}/checkpoint_status

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

pipeline_namestring required

Unique pipeline name

Query parameters

incarnation_uuidstring uuid nullable

Incarnation UUID returned by the POST checkpoint request this status check is for. If given and it does not match the pipeline's current incarnation, the pipeline process has restarted since the checkpoint was requested and the response is a 400 error rather than a status.

Response

Checkpoint status retrieved successfully

successinteger nullable

Most recently successful checkpoint.

Changes

No recorded changes to this operation across all 51 revisions of this API.