Skip to Content
API ReferencePipeline LifecycleGet Checkpoint Sync Status

Get Checkpoint Sync Status

GET/v0/pipelines/{pipeline_name}/checkpoint/sync_status
Authentication
Parameters

Retrieve status of checkpoint sync activity in a pipeline.

Authentication

SchemeTypeDetails
JSON web token (JWT) or API keyBearer tokenAuthorization 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

NameTypeRequiredDescription
pipeline_namestringYesUnique pipeline name

Response

application/json
Checkpoint sync status retrieved successfully
  • object
    Checkpoint status returned by the `/checkpoint/sync_status` endpoint.
    • failureobject
    • periodicstring (uuid)
      Most recently successful automated periodic checkpoint sync.
    • successstring (uuid)
      Most recently successful checkpoint sync.
Request
curl -X GET '/v0/pipelines/{pipeline_name}/checkpoint/sync_status' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
Pipeline with that name does not exist
{ "message": "Unknown pipeline name 'non-existent-pipeline'", "error_code": "UnknownPipelineName", "details": { "pipeline_name": "non-existent-pipeline" } }