PATCH
/
core
/
pipeline
/
{id}
curl --request PATCH \
  --url https://api.openint.dev/v0/core/pipeline/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-apikey: <api-key>' \
  --header 'x-connection-id: <api-key>' \
  --data '{
  "metadata": "<any>",
  "disabled": true,
  "streams": {}
}'
{
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "id": "<string>",
  "sourceId": "<string>",
  "sourceState": {},
  "sourceVertical": "<string>",
  "streams": {},
  "destinationId": "<string>",
  "destinationState": {},
  "destinationVertical": "<string>",
  "linkOptions": [
    "<any>"
  ],
  "lastSyncStartedAt": "<string>",
  "lastSyncCompletedAt": "<string>",
  "disabled": true,
  "metadata": "<any>"
}

Authorizations

​
x-apikey
string
header
required
​
x-connection-id
string
header
required

Path Parameters

​
id
string
required

Must start with 'pipe_'

Body

application/json
​
metadata
any

JSON object can can be used to associate arbitrary metadata to avoid needing a separate 1-1 table just for simple key values in your application. During updates this object will be shallowly merged

​
disabled
boolean
​
streams
object | null

Response

200
application/json
Successful response
​
createdAt
string
required
​
updatedAt
string
required
​
id
string
required

Must start with 'pipe_'

​
sourceId
string

Must start with 'conn_'

​
sourceState
object
​
sourceVertical
string | null
​
streams
object | null
​
destinationId
string

Must start with 'conn_'

​
destinationState
object
​
destinationVertical
string | null
​
linkOptions
any[] | null
​
lastSyncStartedAt
string | null
​
lastSyncCompletedAt
string | null
​
disabled
boolean
​
metadata
any

JSON object can can be used to associate arbitrary metadata to avoid needing a separate 1-1 table just for simple key values in your application. During updates this object will be shallowly merged

Previous
Sync pipeline
Next