Sign in
Pipeline Lifecycle

Get Checkpoint Sync Status

Required role: read or higher.

Retrieve status of checkpoint sync activity in a pipeline.

get/v0/pipelines/{pipeline_name}/checkpoint/sync_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/sync 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 sync was requested and the response is a 400 error rather than a status.

Response

Checkpoint sync status retrieved successfully

periodicstring uuid nullable

Most recently successful automated periodic checkpoint sync.

runningstring[]

Checkpoint syncs running right now.

A UUID leaves running and lands in success or failure at the same moment.

Periodic syncs do not appear here.

successstring uuid nullable

Most recently successful checkpoint sync.

If success and failure would otherwise name the same UUID, then the most recent result is set and the other is cleared.

Changes

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