Set pipeline status

Pause or resume a pipeline by flipping its status.

PUT /platform/pipeline-api/{pipeline_id}/

Set pipeline status

cURL

curl --request PUT \
  --url https://api.covalenthq.com/platform/pipeline-api/{pipeline_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

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

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.covalenthq.com/platform/pipeline-api/{pipeline_id}/', 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}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.covalenthq.com/platform/pipeline-api/{pipeline_id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

200

{
  "data": {
    "id": "pipe_3e8678c5fc9e48a7bf9879ca729",
    "name": "From Base Swap to Postgres",
    "project": "pipeline-api-hr-1wk-unbounded",
    "description": "Base swaps, unbounded",
    "topic": "base.mainnet.ref.block.swap.v3",
    "destination_config": {
      "type": "<string>",
      "url": "<string>",
      "user": "<string>",
      "password": "<string>"
    },
    "transforms": {
      "swaps": "SELECT chain_name, block_height, tx_hash FROM swaps WHERE protocol = 'uniswap_v3'"
    },
    "execution_start_from": "44745000",
    "execution_stop_from": "",
    "abi_file": {},
    "abi_contract_addresses": [
      "<string>"
    ],
    "created_by": {
      "id": "user_fb22f43e38ac44edabc7f566c5d",
      "email": "[e-mail]",
      "display_name": "<string>",
      "full_name": "<string>"
    },
    "group": {
      "id": "group_d632592ddbde4a499452d25b",
      "name": "<string>",
      "slug": "<string>",
      "is_paid": true,
      "is_over_limit": true,
      "is_free_trial_expired": true
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "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>"
}

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

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

Requires a ServiceKey. See Service Keys.

PUT only changes the pipeline’s status between running and paused. To edit any other field - name, transforms, destination config - use PATCH.

curl https://api.covalenthq.com/platform/pipeline-api/pipe_3e8678c5fc9e48a7bf9879ca729/ \
  -X PUT \
  -H "Authorization: Bearer $GOLDRUSH_SERVICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status": "paused"}'

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

Body

application/json

Body for PUT /platform/pipeline-api/{pipeline_id}/. Only status is accepted; all other fields are ignored.

status · enum<string> · required

Target status. Set to paused to pause a running pipeline, or running to resume a paused one.

Available options: running, paused

Response

200

application/json

Updated pipeline.

data · object

A configured pipeline. Sensitive fields inside destination_config (such as passwords) are masked as ****** on read.

Show child attributes

error · boolean

error_message · string | null

error_code · string | null