Get pipeline logs

Fetch recent log lines from the pipeline runtime, grouped by pod.

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

Get pipeline logs

cURL

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

import requests

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

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}/logs/', 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}/logs/",
  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}/logs/"

	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}/logs/")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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",
    "pods": [
      {
        "pod": "pipeline-covalent-postgres-pipe-fa28e4ef28fa4f7b9ffc62e162dmlm2",
        "logs": "<string>"
      }
    ]
  },
  "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.

Returns the concatenated tail of stdout/stderr for each pod backing the pipeline worker. The response is shaped as data.pods[], with one entry per replica - single-replica pipelines return a one-element array.

The logs field on each pod is a single string, not a list of structured log entries. Newlines separate lines. Filter, parse, or tail it client-side.

If the pod is still being scheduled, has just crashed, or has been replaced, the logs field may contain a runtime tail error such as unable to upgrade connection: container not found. The envelope-level error field is still false in this case - the API call itself succeeded, but there was nothing to tail. Retry after the pipeline reaches RUNNING via status.

Useful when:

• A POST succeeded but status is FAILED.
• destination-health reports unhealthy and you need the underlying connection error.
• Records are not arriving at the destination and you want to see normalization or transform errors.

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

Recent pipeline logs.

data · object

Show child attributes

error · boolean

error_message · string | null

error_code · string | null