> ## 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.

# Get pipeline status

> Check the runtime deployment phase of a pipeline.

<Info>
  Requires a **ServiceKey**. See [Service Keys](/goldrush-pipeline-api/service-keys).
</Info>

This endpoint reports the runtime deployment phase of the pipeline worker - `DEPLOYING`, `RUNNING`, `PAUSED`, `FAILED`, `STOPPING`, `STOPPED`.

<Note>
  This is **not** the same as the `status` field on the pipeline object returned by [`GET /platform/pipeline-api/{pipeline_id}/`](/api-reference/pipeline-api/get-pipeline). 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.
</Note>

<Tip>
  After creating or updating a pipeline, poll this endpoint every few seconds until `status == "RUNNING"` and `ready == replicas` to confirm the pipeline is live.
</Tip>


## OpenAPI

````yaml GET /platform/pipeline-api/{pipeline_id}/status/
openapi: 3.1.0
info:
  title: GoldRush Pipeline API
  version: 1.0.0
  description: >-
    REST API for programmatic CRUD over GoldRush pipelines. Authentication uses
    a ServiceKey - regular GoldRush API keys are not accepted on these
    endpoints.
servers:
  - url: https://api.covalenthq.com
security:
  - serviceKeyAuth: []
paths:
  /platform/pipeline-api/{pipeline_id}/status/:
    parameters:
      - name: pipeline_id
        in: path
        required: true
        description: The pipeline identifier, prefixed with `pipe_`.
        schema:
          type: string
    get:
      tags:
        - pipelines
      summary: Get pipeline status
      description: >-
        Lightweight status check. Use this for polling in dashboards or CI
        rather than re-fetching the full pipeline object.
      operationId: getPipelineStatus
      responses:
        '200':
          description: Pipeline status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineStatusEnvelope'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    PipelineStatusEnvelope:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PipelineStatus'
        error:
          type: boolean
        error_message:
          type: string
          nullable: true
        error_code:
          type: string
          nullable: true
    PipelineStatus:
      type: object
      description: >-
        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.
      properties:
        uid:
          type: string
          description: Internal runtime identifier of the pipeline worker.
          example: covalent-postgres-pipe-fa28e4ef28fa4f7b9ffc62e162d
        status:
          type: string
          description: Runtime deployment phase.
          enum:
            - DEPLOYING
            - RUNNING
            - PAUSED
            - FAILED
            - STOPPING
            - STOPPED
        replicas:
          type: integer
          description: Desired replica count.
        ready:
          type: integer
          description: Replicas currently reporting ready.
        start_time:
          type: string
          format: date-time
          description: When the current deployment was started.
    ErrorEnvelope:
      type: object
      properties:
        data:
          type: object
          nullable: true
        error:
          type: boolean
        error_message:
          type: string
        error_code:
          type: string
  responses:
    Unauthorized:
      description: Missing or invalid ServiceKey.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: >-
        The credential supplied is not a ServiceKey, or the ServiceKey does not
        have access to this pipeline.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: Pipeline does not exist or is not visible to this ServiceKey.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    serviceKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: ServiceKey
      description: >-
        Pipeline REST endpoints require a ServiceKey. Regular GoldRush API keys
        are rejected with 403. See [Service
        Keys](/goldrush-pipeline-api/service-keys).

````