POST
/
core
/
connection
curl --request POST \
  --url https://api.openint.dev/v0/core/connection \
  --header 'Content-Type: application/json' \
  --header 'x-apikey: <api-key>' \
  --header 'x-connection-id: <api-key>' \
  --data '{
  "connectorConfigId": "<string>",
  "settings": {},
  "displayName": "<string>",
  "customerId": "<string>",
  "disabled": true,
  "metadata": "<any>",
  "integrationId": "<string>"
}'
"<string>"

Authorizations

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

Body

application/json
​
connectorConfigId
string
required

Must start with 'ccfg_'

​
settings
object | null
​
displayName
string | null
​
customerId
string | null
Minimum length: 1
​
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

​
integrationId
string | null

Must start with 'int_'

Response

200
application/json
Successful response

The response is of type string.

Previous
Get connection
Next