Get the checkpoints for a pipeline

GET/v0/pipelines/{pipeline_name}/checkpoints

Authentication

JSON web token (JWT) or API key (http bearer)

Parameters

pipeline_name (path, string, required)

Retrieve the current checkpoints made by a pipeline.

Authentication

Scheme	Type	Details
`JSON web token (JWT) or API key`	Bearer token	Authorization header · Use a JWT token obtained via an OAuth2/OIDC login workflow or an API key obtained via the `/v0/api-keys` endpoint.

Parameters

Path parameters

Name	Type	Required	Description
`pipeline_name`	string	Yes	Unique pipeline name

Response

application/json

Checkpoints retrieved successfully

object
Holds meta-data about a checkpoint that was taken for persistent storage and recovery of a circuit's state.
- fingerprintinteger (int64)required
  Fingerprint of the circuit at the time of the checkpoint.
- identifierstring
  An optional name for the checkpoint.
- processed_recordsinteger (int64)
  Total number of records processed.
- sizeinteger (int64)
  Total size of the checkpoint files in bytes.
- stepsinteger (int64)
  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.

curl -X GET '/v0/pipelines/{pipeline_name}/checkpoints' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Pipeline with that name does not exist


{
  "message": "Unknown pipeline name 'non-existent-pipeline'",
  "error_code": "UnknownPipelineName",
  "details": {
    "pipeline_name": "non-existent-pipeline"
  }
}