Pipeline Lifecycle

Get the checkpoints for a pipeline

Required role: read or higher.

Retrieve the current checkpoints made by a pipeline.

Stability note: for multihost pipelines, this endpoint returns the combined checkpoint list from all hosts. The shape of this response may change in a future release.

get/v0/pipelines/{pipeline_name}/checkpoints

Request

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

Path parameters

pipeline_namestring required

Unique pipeline name

Response

Checkpoints retrieved successfully. For multihost pipelines the list contains entries from all hosts; the shape of this response may change in a future release.

fingerprintinteger required

Fingerprint of the circuit at the time of the checkpoint.

identifierstring nullable

An optional name for the checkpoint.

processed_recordsinteger nullable

Total number of records processed.

sizeinteger nullable

Total size of the checkpoint files in bytes.

stepsinteger nullable

Total number of steps made.

uuidstring uuid required

A unique identifier for the given checkpoint.

This is used to identify the checkpoint in the file-system hierarchy.

Changes

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