Skip to main content
GET
/
platform
/
pipeline-api
/
{pipeline_id}
/
status
Get pipeline status
curl --request GET \
  --url https://api.covalenthq.com/platform/pipeline-api/{pipeline_id}/status/ \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "uid": "covalent-postgres-pipe-fa28e4ef28fa4f7b9ffc62e162d",
    "status": "DEPLOYING",
    "replicas": 123,
    "ready": 123,
    "start_time": "2023-11-07T05:31:56Z"
  },
  "error": true,
  "error_message": "<string>",
  "error_code": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://goldrush.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

Requires a ServiceKey. See Service Keys.
This endpoint reports the runtime deployment phase of the pipeline worker - DEPLOYING, RUNNING, PAUSED, FAILED, STOPPING, STOPPED.
This is not the same as the status field on the pipeline object returned by GET /platform/pipeline-api/{pipeline_id}/. That field reports user intent (running / paused); this endpoint reports the actual runtime phase, including transient states like DEPLOYING while a newly created pipeline is starting up, or FAILED if the worker has crashed.
After creating or updating a pipeline, poll this endpoint every few seconds until status == "RUNNING" and ready == replicas to confirm the pipeline is live.

Authorizations

​
Authorization
string
header
required

Pipeline REST endpoints require a ServiceKey. Regular GoldRush API keys are rejected with 403. See Service Keys.

Path Parameters

​
pipeline_id
string
required

The pipeline identifier, prefixed with pipe_.

Response

Pipeline status.

​
data
object

Deployment-level status from the underlying runtime. This is distinct from the user-facing status field on the pipeline object: the pipeline object reports user intent (running/paused), while this endpoint reports the runtime deployment phase.

​
error
boolean
​
error_message
string | null
​
error_code
string | null