Get Checkpoint Sync Status

Required role: read or higher.

Retrieve status of checkpoint sync activity in a pipeline.

Path Parameters
pipeline_name string — REQUIRED Unique pipeline name

Query Parameters
incarnation_uuid uuid Incarnation UUID returned by the POST checkpoint/sync request this status check is for. If given and it does not match the pipeline's current incarnation, the pipeline process has restarted since the sync was requested and the response is a 400 error rather than a status.

Responses
200 Checkpoint sync status retrieved successfully Schema — OPTIONAL failure object — OPTIONAL Information about a failed checkpoint sync. error string Error message associated with the failure. uuid uuid UUID of the failed checkpoint. periodic uuid — OPTIONAL Most recently successful automated periodic checkpoint sync. running uuid[] — OPTIONAL Checkpoint syncs running right now. A UUID leaves running and lands in success or failure at the same moment. Periodic syncs do not appear here. success uuid — OPTIONAL Most recently successful checkpoint sync. If success and failure would otherwise name the same UUID, then the most recent result is set and the other is cleared.
400 The given incarnation_uuid does not match the pipeline's current incarnation (error code IncarnationUuidMismatch): the pipeline process has restarted since the sync was requested 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.
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.