Update Connection
UpdateConnection updates a Connection 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
Cookie authentication used by the Versori Platform.
Path Parameters
ID is the unique identifier of the Connection.
Body
ID is the unique identifier of the Connection.
OrganisationID is the unique identifier of the Organisation that owns the Connection.
Name is the user-provided name of the Connection
ProtocolType denotes the set of all valid connection types.
http
, bigquery
AuthSchemeConfigs, if set, will overwrite the existing list of auth scheme configs with the provided array. This will not affect any existing Environments since they store a copy of the Auth Scheme on creation. In order to update an Environment with an updated Auth Scheme, the user should update the Credential directly.
"none"
Environments, if set, will overwrite the existing list of environments with the provided array. This array
can only specify existing environments (without edits) or new environments. This is useful for replacing an
existing Environment with a new one, or reordering. It's recommended to use the UpdateEnvironment
operation to update a single environment.
ID is the unique identifier of the Environment. Typically this is only used internally and most (if not all)
public-facing APIs will use the name
in combination with the Connection's id
instead.
Name is the new name of the Environment.
EnvironmentCredentialsUpdate defines the Action and Trigger credentials for the owning Connection.
Only the order and the AuthSchemeConfig of each EnvironmentCredential can be updated. To update the underlying
Credential, the UpdateCredential
operation should be used.
Variables, if set, will replace the existing variables in the Environment. Setting to an empty array will delete all variables. Omitting this field will leave the existing variables unchanged.
BaseURL is the base URL of all HTTP Actions within the Connection.
EnvironmentVariables, if set, will overwrite the existing list of environment variables or create new ones with the provided array. This action will be performed on all the connection environments as well.
Name is the name of the environment variable.
Value is the value of the environment variable.
Response
ID is the unique identifier of the Connection.
OrganisationID is the unique identifier of the Organisation that owns the Connection.
Name is the user-provided name of the Connection
ProtocolType denotes the set of all valid connection types.
http
, bigquery
"none"
Environment Variables is a list of default variables initialised in every connection environment.
Name is the name of the environment variable.
Value is the value of the environment variable.
Environments is a list of all the environments this Connection has.
ID is the unique identifier of the Environment. Typically this is only used internally and most (if not all)
public-facing APIs will use the name
in combination with the Connection's id
instead.
Name is the name of the Environment. This must be unique within the owning Connection.
EnvironmentCredentials defines the Action and Trigger credentials for the owning Connection. If multiple credentials are defined for each type, they are applied to the request in the order they are defined. This is to enable Connections which require both a user session token and an API key to be provided in the request.
CreatedAt is the time the Environment was created.
UpdatedAt is the time the Environment was last updated.
Versions is a list of all the versions this Connection has.
ID is the unique identifier of the ConnectionVersion, this is typically only used internally and the version
name
is used externally in combination with the Connection id
.
Name denotes the actual version value for the Connection. 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 ConnectionVersion, such as what changed since the last version etc.
IsLatest denotes whether this is the latest version of the Connection.
IsDefault denotes whether this is the default version of the Connection.
CreatedAt is the time at which the ConnectionVersion was created.
UpdatedAt is the time at which the ConnectionVersion was last updated, including any changes to child resources.
PublishedAt is the time at which the ConnectionVersion was published.
CreatedAt is the time at which the ConnectionVersion was created.
UpdatedAt is the time at which the ConnectionVersion was last updated, including any changes to child resources.
BaseURL is the base URL of all HTTP Actions within the Connection.