Get pipeline status

Check the runtime deployment phase of a pipeline.

GET /platform/pipeline-api/{pipeline_id}/status/

Get pipeline status

cURL

curl --request GET \
  --url https://api.covalenthq.com/platform/pipeline-api/{pipeline_id}/status/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.covalenthq.com/platform/pipeline-api/{pipeline_id}/status/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.covalenthq.com/platform/pipeline-api/{pipeline_id}/status/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.covalenthq.com/platform/pipeline-api/{pipeline_id}/status/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.covalenthq.com/platform/pipeline-api/{pipeline_id}/status/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.covalenthq.com/platform/pipeline-api/{pipeline_id}/status/")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.covalenthq.com/platform/pipeline-api/{pipeline_id}/status/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "uid": "covalent-postgres-pipe-fa28e4ef28fa4f7b9ffc62e162d",
    "replicas": 123,
    "ready": 123,
    "start_time": "2023-11-07T05:31:56Z"
  },
  "error": true,
  "error_message": "<string>",
  "error_code": "<string>"
}

{
  "data": {},
  "error": true,
  "error_message": "<string>",
  "error_code": "<string>"
}

{
  "data": {},
  "error": true,
  "error_message": "<string>",
  "error_code": "<string>"
}

{
  "data": {},
  "error": true,
  "error_message": "<string>",
  "error_code": "<string>"
}

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

200

application/json

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.

Show child attributes

error · boolean

error_message · string | null

error_code · string | null