PUT
/
o
/
{organisation_id}
/
connectors
/
{connector_id}
/
connections
/
{connection_id}

Authorizations

Authorization
string
headerrequired

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
required
connector_id
string
required

ID is the unique identifier of the Connector.

connection_id
string
required

Body

application/json

ConnectionUpdate defines the updates to apply to an existing Connection.

This supports renaming the Connection, editing variables, and updating the order and AuthSchemeConfig of each ConnectionCredential.

id
string
required

ID is the unique identifier of the Connection. Typically this is only used internally and most (if not all) public-facing APIs will use the name in combination with the Connector's id instead.

name
string
required

Name is the new name of the Connection.

credentials
object

ConnectionCredentialsUpdate defines the Action and Trigger credentials for the owning Connector.

Only the order and the AuthSchemeConfig of each ConnectionCredential can be updated. To update the underlying Credential, the UpdateCredential operation should be used.

credentials.action
object[]
credentials.trigger
object[]
variables
object[]

Variables, if set, will replace the existing variables in the Connection. Setting to an empty array will delete all variables. Omitting this field will leave the existing variables unchanged.

variables.name
string
required

Name is the name of the connection variable.

variables.value
string
required

Value is the value of the connection variable.

Response

200 - application/json

Connection defines the Action and Trigger credentials for the owning Connector, and additional variables which can be used to customize the Connector in a particular connection.

id
string
required

ID is the unique identifier of the Connection. Typically this is only used internally and most (if not all) public-facing APIs will use the name in combination with the Connector's id instead.

name
string
required

Name is the name of the Connection. This must be unique within the owning Connector.

credentials
object
required

ConnectionCredentials defines the Action and Trigger credentials for the owning Connector. If multiple credentials are defined for each type, they are applied to the request in the order they are defined. This is to enable Connectors which require both a user session token and an API key to be provided in the request.

credentials.action
object[]
credentials.trigger
object[]
variables
object[]
required
variables.name
string
required

Name is the name of the connection variable.

variables.value
string
required

Value is the value of the connection variable.

createdAt
string
required

CreatedAt is the time the Connection was created.

updatedAt
string
required

UpdatedAt is the time the Connection was last updated.

Get ConnectionDelete Connection