Skip to main content
POST
/
v2.0
/
connections
Creates a new Connection
curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "some name",
  "isDeprecated": true,
  "type": "http_basic",
  "extension": "@cognigy/basic-nodes",
  "fields": {
    "some-key-from-connection-schema": "x123sdfu12312"
  },
  "projectId": "<string>"
}'
{
  "key": "some-key-from-connection-schema",
  "value": "x123w123",
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
api_key
string
query
required

Supply the API Key in the Url-Query

Headers

​
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Body

application/json
  • Option 1
  • Option 2

Either projectId or resourceLevel: organization must be present in the request body.

​
name
string
Example:

"some name"

​
isDeprecated
boolean

Marked 'true' if the connection type is deprecated

​
type
string
Example:

"http_basic"

​
extension
string
Example:

"@cognigy/basic-nodes"

​
fields
object

The fields of the Connection. Key-Value pairs. The key should match the connection schema of the specific connection type.

Example:
{
  "some-key-from-connection-schema": "x123sdfu12312"
}
​
projectId
string
Required string length: 24

Response

Returns Connection metadata object.

The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.

​
key
string

The key of the connection field. The key should match the connection schema of the specific connection type.

Example:

"some-key-from-connection-schema"

​
value
string

The value of the connection field

Example:

"x123w123"

​
_id
string
Required string length: 24
​
createdAt
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
lastChanged
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
createdBy
string
Required string length: 24
​
lastChangedBy
string
Required string length: 24