Update Connector
UpdateConnector updates a Connector with the specified request body. All mutable fields are updated as per the
request body, and the updatedAt field is set to the current time. Any missing fields will be unset unless this
causes a validation error, in which case the request will fail with a 400 Bad Request response.
Authorizations
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
ID is the unique identifier of the Connector.
Body
ConnectorUpdate is the input to the UpdateConnector endpoint.
ID is the unique identifier of the Connector.
OrganisationID is the unique identifier of the Organisation that owns the Connector.
Name is the user-provided name of the Connector
ProtocolType denotes the set of all valid connector types.
http, bigquery BaseURL is the base URL of all HTTP Actions within the Connector.
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.
Hold an optional link to the documentation for the API.
The URL for the icon for the connector
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.
Name is the name of the connection variable.
Value is the value of the connection variable.
Response
Connector represents a connector to an external system.
ID is the unique identifier of the Connector.
OrganisationID is the unique identifier of the Organisation that owns the Connector.
Name is the user-provided name of the Connector
ProtocolType denotes the set of all valid connector types.
http, bigquery ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and only requires to be unique amongst the elements of the array in which is it contained.
Description enables users to distinguish multiple configurations which use the same schemeType.
ValidationMessages is a list of messages which are generated when the AuthSchemeConfig is validated. This is typically used to provide feedback to the user when they are creating or updating the AuthSchemeConfig.
This field will be ignored if sent to the API.
"none"Connections is a list of all the connections this Connector has.
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 is the name of the Connection. This must be unique within the owning Connector.
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.
CreatedAt is the time the Connection was created.
UpdatedAt is the time the Connection was last updated.
Versions is a list of all the versions this Connector has.
ID is the unique identifier of the ConnectorVersion, this is typically only used internally and the version
name is used externally in combination with the Connector id.
Name denotes the actual version value for the Connector. This can be any value but a consistent naming strategy is recommended, such as SemVer, CalVer or an incrementing number. The names "default" and "latest" are reserved words and cannot be used.
Description allows specifying additional information about the ConnectorVersion, such as what changed since the last version etc.
IsLatest denotes whether this is the latest version of the Connector.
IsDefault denotes whether this is the default version of the Connector.
CreatedAt is the time at which the ConnectorVersion was created.
UpdatedAt is the time at which the ConnectorVersion was last updated, including any changes to child resources.
PublishedAt is the time at which the ConnectorVersion was published.
CreatedAt is the time at which the ConnectorVersion was created.
UpdatedAt is the time at which the ConnectorVersion was last updated, including any changes to child resources.
BaseURL is the base URL of all HTTP Actions within the Connector.
Hold an optional link to the documentation for the API.
The URL for the icon for the connector
Connection Variables is a list of default variables initialised in every connector connection.
Name is the name of the connection variable.
Value is the value of the connection variable.