Checkpoint Now

POST/v0/pipelines/{pipeline_name}/checkpoint

Authentication

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

Parameters

pipeline_name (path, string, required)

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.

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

Checkpoint initiated

object
Response to a checkpoint request.
- checkpoint_sequence_numberinteger (int64)required

curl -X POST '/v0/pipelines/{pipeline_name}/checkpoint' \
  -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"
  }
}