Create HTTP Connector

CreateHTTPConnector creates a new HTTP Connector. By default the Connector will be created in a draft state and will need to be published before it can be used by other Versori products.

POST /o/{organisation_id}/protocols/http/connectors

Create HTTP Connector

cURL

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>",
  "authSchemeConfigs": [
    {
      "id": "<string>",
      "description": "<string>",
      "schemeType": "<string>",
      "validationMessages": [
        {
          "text": "<string>",
          "detail": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "connectionVariables": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "tags": {},
  "public": true
}
'

201

{
  "id": "<string>",
  "organisationId": "<string>",
  "name": "<string>",
  "public": true,
  "authSchemeConfigs": [
    {
      "id": "<string>",
      "description": "<string>",
      "schemeType": "<string>",
      "validationMessages": [
        {
          "text": "<string>",
          "detail": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "connections": [
    {
      "id": "<string>",
      "name": "<string>",
      "credentials": {
        "action": [
          {
            "id": "<string>",
            "authSchemeConfig": {
              "id": "<string>",
              "description": "<string>",
              "schemeType": "<string>",
              "validationMessages": [
                {
                  "text": "<string>",
                  "detail": [
                    "<string>"
                  ]
                }
              ]
            },
            "credential": {
              "id": "<string>",
              "organisationId": "<string>",
              "name": "<string>",
              "data": {},
              "usages": [
                {
                  "connection": {
                    "id": "<string>",
                    "name": "<string>",
                    "connector": {
                      "id": "<string>",
                      "organisationId": "<string>",
                      "name": "<string>",
                      "createdAt": "2023-11-07T05:31:56Z",
                      "updatedAt": "2023-11-07T05:31:56Z"
                    },
                    "createdAt": "2023-11-07T05:31:56Z",
                    "updatedAt": "2023-11-07T05:31:56Z"
                  }
                }
              ],
              "errors": [
                "<string>"
              ],
              "expiresAt": "2023-11-07T05:31:56Z"
            }
          }
        ],
        "trigger": [
          {
            "id": "<string>",
            "authSchemeConfig": {
              "id": "<string>",
              "description": "<string>",
              "schemeType": "<string>",
              "validationMessages": [
                {
                  "text": "<string>",
                  "detail": [
                    "<string>"
                  ]
                }
              ]
            },
            "credential": {
              "id": "<string>",
              "organisationId": "<string>",
              "name": "<string>",
              "data": {},
              "usages": [
                {
                  "connection": {
                    "id": "<string>",
                    "name": "<string>",
                    "connector": {
                      "id": "<string>",
                      "organisationId": "<string>",
                      "name": "<string>",
                      "createdAt": "2023-11-07T05:31:56Z",
                      "updatedAt": "2023-11-07T05:31:56Z"
                    },
                    "createdAt": "2023-11-07T05:31:56Z",
                    "updatedAt": "2023-11-07T05:31:56Z"
                  }
                }
              ],
              "errors": [
                "<string>"
              ],
              "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>",
      "isLatest": true,
      "isDefault": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "publishedAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "messages": [
        {
          "text": "<string>",
          "detail": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "baseUrl": "<string>",
  "documentationURL": "<string>",
  "imageURL": "<string>",
  "tags": {},
  "connectionVariables": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ]
}

Authorizations

bearerTokencookie

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

AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its authentication requirements. This is purely the configuration and not the actual credential which is used to authenticate. The credential uses this configuration to determine how to authenticate.

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Show child attributes

connectionVariables · object[]

Show child attributes

tags · object

public · boolean

Response

201

application/json

Created

HTTPConnector represents a connector to an external system over HTTP.

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: http, bigquery

Allowed value: "http"

authSchemeConfigs · object[] · required

AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its authentication requirements. This is purely the configuration and not the actual credential which is used to authenticate. The credential uses this configuration to determine how to authenticate.

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Show child attributes

connections · object[] · required

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

Show child attributes

versions · object[] · required

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

Show child attributes

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.

Show child attributes