Skip to main content
PUT
/
platform
/
pipeline-api
/
{pipeline_id}
Set pipeline status
curl --request PUT \
  --url https://api.covalenthq.com/platform/pipeline-api/{pipeline_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "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": "jsmith@example.com",
      "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>"
}

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

Updated pipeline.

​
data
object

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

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