Sign in
Pipelines

Get Pipeline Status

Changed on

Get the status of a pipeline by ID.

get/api/v1/pipelines/{pipeline_id}/status

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

pipeline_idstring uuid required

Query parameters

full_detailsboolean nullable

Cookies

sessionstring nullable

Response

Successful Response

job_idstring uuid nullable

ID of the latest job.

deployment_datestring date-time nullable

Date of the deployment.

status'NOT_STARTED' | 'IN_PROGRESS' | 'SUCCESS' | 'ERROR' | 'PARTIAL_SUCCESS' | 'CANCELLED' required

Status of managed ingestion with partial Updates.

effective_atstring date-time nullable

When the status is effective

Changes

  • 7a98f91d4000Revision changes
    • ○

      added the new optional query request parameter full_details

    • ○

      removed the FILES_UPDATE enum value from the /// response property for the response status