PATCH
/
core
/
connector_config
/
{id}
curl --request PATCH \
  --url https://api.openint.dev/v0/core/connector_config/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-apikey: <api-key>' \
  --header 'x-connection-id: <api-key>' \
  --data '{
  "metadata": "<any>",
  "displayName": "<string>",
  "disabled": true
}'
{
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "id": "<string>",
  "connectorName": "<string>",
  "config": {},
  "orgId": "<string>",
  "displayName": "<string>",
  "disabled": true,
  "defaultPipeOut": {
    "streams": {},
    "links": [
      "unified_banking"
    ],
    "destination_id": "<string>"
  },
  "defaultPipeIn": {
    "links": [
      "unified_banking"
    ],
    "source_id": "<string>"
  },
  "envName": "<string>",
  "metadata": "<any>"
}

Authorizations

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

Path Parameters

​
id
string
required

Must start with 'ccfg_'

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

​
displayName
string | null
​
disabled
boolean

When disabled it will not be used for connection portal. Essentially a reversible soft-delete

Response

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

Must start with 'ccfg_'

​
connectorName
string
required
​
orgId
string
required

Must start with 'org_'

​
config
object | null
​
displayName
string | null
​
disabled
boolean

When disabled it will not be used for connection portal. Essentially a reversible soft-delete

​
defaultPipeOut
object | null

Automatically sync data from any connections associated with this config to the destination connection, which is typically a Postgres database. Think ETL

​
defaultPipeIn
object | null

Automatically sync data from any connections associated with this config to the destination connection, which is typically a Postgres database. Think ETL

​
envName
string | null
​
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
List connector config infos
Next