Sign in
Pipeline Lifecycle

Checkpoint Now

Required role: write or higher.

Initiates checkpoint for a running or paused pipeline.

Returns a checkpoint sequence number that can be used with /checkpoint_status to determine when the checkpoint has completed.

post/v0/pipelines/{pipeline_name}/checkpoint

Request

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

Path parameters

pipeline_namestring required

Unique pipeline name

Response

Checkpoint initiated

checkpoint_sequence_numberinteger required
incarnation_uuidstring uuid nullable

Pass back to /checkpoint_status to detect pipeline restarts.

Only None if sent by an older pipeline.

Changes

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