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.
ConnectionVariable denotes an arbitrary key/value pair which can be used to configure a connector.
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.
ConnectionVariable denotes an arbitrary key/value pair which can be used to configure a connector.
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.
bigquery
DatasetID is the ID of the BigQuery dataset, in the format "<project_id>.<dataset_name>"
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
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
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.
Connections is a list of all the connections this Connector has.
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.
Versions is a list of all the versions this Connector has.
ConnectorVersion represents a version of a 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.
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.
ConnectionVariable denotes an arbitrary key/value pair which can be used to configure a connector.
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
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.
Connections is a list of all the connections this Connector has.
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.
Versions is a list of all the versions this Connector has.
ConnectorVersion represents a version of a 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.
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.
ConnectionVariable denotes an arbitrary key/value pair which can be used to configure a connector.
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
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.
Connections is a list of all the connections this Connector has.
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.
Versions is a list of all the versions this Connector has.
ConnectorVersion represents a version of a 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.
DatasetID is the ID of the BigQuery dataset, in the format "<project_id>.<dataset_name>"
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.
ConnectionVariable denotes an arbitrary key/value pair which can be used to configure a connector.