PUT
/
o
/
{organisation_id}
/
connectors
/
{connector_id}
Update Connector
curl --request PUT \
  --url https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "organisationId": "<string>",
  "name": "<string>",
  "tags": {},
  "protocol": "http",
  "authSchemeConfigIds": [
    "<string>"
  ],
  "public": true,
  "documentationURL": "<string>",
  "imageURL": "<string>",
  "baseUrl": "<string>",
  "connectionVariables": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ]
}'
{
  "id": "<string>",
  "organisationId": "<string>",
  "name": "<string>",
  "public": true,
  "documentationURL": "<string>",
  "imageURL": "<string>",
  "tags": {},
  "protocol": "http",
  "authSchemeConfigs": [
    {
      "id": "<string>",
      "description": "<string>",
      "validationMessages": [
        {
          "text": "<any>",
          "severity": "<any>",
          "detail": "<any>"
        }
      ],
      "schemeType": "<string>"
    }
  ],
  "connectionVariables": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "connections": [
    {
      "id": "<string>",
      "name": "<string>",
      "credentials": {
        "action": [
          "<any>"
        ],
        "trigger": [
          "<any>"
        ]
      },
      "variables": [
        {
          "name": "<any>",
          "value": "<any>"
        }
      ],
      "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": "<any>",
          "severity": "<any>",
          "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
​
connector_id
string<ulid>
required

ID is the unique identifier of the Connector.

Body

application/json

ConnectorUpdate is the input to the UpdateConnector endpoint. HTTPConnectorUpdate is the input to the UpdateHTTPConnector endpoint. Connections cannot be updated via the UpdateHTTPConnector endpoint. To update an Connection, use the UpdateConnection endpoint.

ConnectorUpdateBase provides the common fields to update any Connector type. Attempts to mutate a field marked

Versions cannot be updated via this endpoint.

​
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

​
protocol
enum<string>
required

ProtocolType denotes the set of all valid connector types.

Available options:
TitleConst
http
​
baseUrl
string
required

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

​
tags
object
​
authSchemeConfigIds
string[]

AuthSchemeConfigIDs allows reordering the AuthSchemeConfigs for the Connector. This field cannot be used to create/edit/delete individual AuthSchemeConfigs, for those use cases, see the API endpoints at /o/:organisationId/connectors/:connectorId/auth-scheme-configs[/:id]. If this field is omitted then the AuthSchemeConfigs are not edited.

​
public
boolean
​
documentationURL
string

Hold an optional link to the documentation for the API.

​
imageURL
string

The URL for the icon for the connector

​
connectionVariables
object[]

ConnectionVariables, if set, will overwrite the existing list of connection variables or create new ones with the provided array. This action will be performed on all the connector connections as well.

Response

OK

Connector represents a connector to an external system. 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.