Skip to main content

Get the checkpoints for a pipeline

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.

Path Parameters
pipeline_name string REQUIRED

Unique pipeline name

Responses
200

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

Schema OPTIONAL
object[]
fingerprint int64

Fingerprint of the circuit at the time of the checkpoint.

identifier string OPTIONAL

An optional name for the checkpoint.

processed_records int64 OPTIONAL

Total number of records processed.

size int64 OPTIONAL

Total size of the checkpoint files in bytes.

steps int64 OPTIONAL

Total number of steps made.

uuid uuid

A unique identifier for the given checkpoint.

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

404

Pipeline with that name does not exist

Schema OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.

500
Schema OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.

503
Schema OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.