POST
/
o
/
{organisation_id}
/
protocols
/
http
/
connectors
Create HTTP Connector
curl --request POST \
  --url https://platform.versori.com/api/connect/v1/o/{organisation_id}/protocols/http/connectors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "baseUrl": "<string>",
  "connectionVariables": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "authSchemeConfigs": [
    {
      "id": "<string>",
      "description": "<string>",
      "validationMessages": [
        {
          "text": "<string>",
          "severity": "info",
          "detail": [
            "<any>"
          ]
        }
      ],
      "schemeType": "<string>"
    }
  ],
  "tags": {},
  "public": true
}'
{
  "id": "<string>",
  "organisationId": "<string>",
  "name": "<string>",
  "public": true,
  "documentationURL": "<string>",
  "imageURL": "<string>",
  "tags": {},
  "protocol": "http",
  "authSchemeConfigs": [
    {
      "id": "<string>",
      "description": "<string>",
      "validationMessages": [
        "<any>"
      ],
      "schemeType": "<string>"
    }
  ],
  "connectionVariables": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "connections": [
    {
      "id": "<string>",
      "name": "<string>",
      "credentials": {
        "action": [
          {
            "id": "<string>",
            "authSchemeConfig": {
              "id": "<string>",
              "description": "<string>",
              "validationMessages": [
                "<any>"
              ],
              "schemeType": "<string>"
            },
            "credential": {
              "id": "<string>",
              "organisationId": "<string>",
              "type": "none",
              "name": "<string>",
              "usages": [
                "<any>"
              ],
              "errors": [
                "<any>"
              ],
              "data": {},
              "expiresAt": "2023-11-07T05:31:56Z"
            }
          }
        ],
        "trigger": [
          {
            "id": "<string>",
            "authSchemeConfig": {
              "id": "<string>",
              "description": "<string>",
              "validationMessages": [
                "<any>"
              ],
              "schemeType": "<string>"
            },
            "credential": {
              "id": "<string>",
              "organisationId": "<string>",
              "type": "none",
              "name": "<string>",
              "usages": [
                "<any>"
              ],
              "errors": [
                "<any>"
              ],
              "data": {},
              "expiresAt": "2023-11-07T05:31:56Z"
            }
          }
        ]
      },
      "variables": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "versions": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "isLatest": true,
      "isDefault": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "publishedAt": "2023-11-07T05:31:56Z",
      "messages": [
        {
          "text": "<string>",
          "severity": "info",
          "detail": [
            "<any>"
          ]
        }
      ]
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "baseUrl": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however internal consumers must provide a JWT id_token issued by our IdP.

Path Parameters

​
organisation_id
string<ulid>
required

Body

application/json

HTTPConnectorCreate is the input to the CreateHTTPConnector endpoint.

​
name
string
required

Name is a user-friendly identifier for a Connector

​
baseUrl
string
required

BaseURL is the base URL of all HTTP Actions within the Connector.

​
authSchemeConfigs
object[]
required
​
connectionVariables
object[]
​
tags
object
​
public
boolean

Response

Created

HTTPConnector represents a connector to an external system over HTTP. ConnectorBase holds common fields which exist across all Connector protocols.

​
id
string<ulid>
required

ID is the unique identifier of the Connector.

​
organisationId
string<ulid>
required

OrganisationID is the unique identifier of the Organisation that owns the Connector.

​
name
string
required

Name is the user-provided name of the Connector

​
public
boolean
required
​
protocol
enum<string>
required

ProtocolType denotes the set of all valid connector types.

Available options:
TitleConst
http
​
authSchemeConfigs
object[]
required
​
connections
object[]
required

Connections is a list of all the connections this Connector has.

​
versions
object[]
required

Versions is a list of all the versions this Connector has.

​
createdAt
string<date-time>
required

CreatedAt is the time at which the ConnectorVersion was created.

​
updatedAt
string<date-time>
required

UpdatedAt is the time at which the ConnectorVersion was last updated, including any changes to child resources.

​
baseUrl
string
required

BaseURL is the base URL of all HTTP Actions within the Connector.

​
documentationURL
string

Hold an optional link to the documentation for the API.

​
imageURL
string

The URL for the icon for the connector

​
tags
object
​
connectionVariables
object[]

Connection Variables is a list of default variables initialised in every connector connection.