Update Connection - Versori User Documentation

PUT

{organisation_id}

connections

{connection_id}

Authorizations

string

cookierequired

Cookie authentication used by the Versori Platform.

Path Parameters

organisation_id

string

required

connection_id

string

required

ID is the unique identifier of the Connection.

Body

application/json

string

required

ID is the unique identifier of the Connection.

organisationId

string

required

OrganisationID is the unique identifier of the Organisation that owns the Connection.

name

string

required

Name is the user-provided name of the Connection

protocol

enum<string>

required

ProtocolType denotes the set of all valid connection types.

Available options:

http,

bigquery

authSchemeConfigs

object[]

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.

environments

object[]

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.

environments.id

string

required

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.

environments.name

string

required

Name is the new name of the Environment.

environments.credentials

object

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.

environments.variables

object[]

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

string

required

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

environmentVariables

object[]

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.

Response

200 - application/json

string

required

ID is the unique identifier of the Connection.

organisationId

string

required

OrganisationID is the unique identifier of the Organisation that owns the Connection.

name

string

required

Name is the user-provided name of the Connection

protocol

enum<string>

required

ProtocolType denotes the set of all valid connection types.

Available options:

http,

bigquery

authSchemeConfigs

object[]

environmentVariables

object[]

Environment Variables is a list of default variables initialised in every connection environment.

environments

object[]

required

Environments is a list of all the environments this Connection has.

environments.id

string

required

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.

environments.name

string

required

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

environments.credentials

object

required

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.

environments.credentials.action

object[]

environments.credentials.action.id

string

required

environments.credentials.action.authSchemeConfig

object

required

AuthSchemeConfig defines how a Connection 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.

environments.credentials.action.credential

object

required

CredentialBase is the base type for all credentials. It contains the common properties which are shared across all credential types.

environments.credentials.action.credential.id

string

required

ID is the unique identifier of the Credential.

environments.credentials.action.credential.type

enum<string>

required

CredentialType denotes the type of the credential which determines what the Credential's data property will contain.

none: No credential is required to authenticate with the Connection.
string: The credential is a string value, such as an API key or password.
binary: The credential is a binary value, such as a private key, certificate or other file.
basic-auth: The credential is a username and password to be used for basic authentication.
oauth2-client: The credential is an OAuth2 client ID and secret to be used for OAuth2 authentication.
oauth2-token: The credential is an OAuth2 access_token to be used for OAuth2 authentication.

Available options:

none,

string,

binary,

basic-auth,

oauth2-client,

oauth2-token

environments.credentials.action.credential.name

string

required

Name is the name of the Credential.

environments.credentials.action.credential.usages

object[]

CredentialUsages is a list of references to the Connections which are using this Credential. To aid performance, this field will only be defined for specific endpoints. An undefined property means that the usages have not been loaded, whereas an empty array indicates that the credential is not used by any connections.

environments.credentials.action.credential.usages.environment

object

required

CredentialUsageEnvironment contains the information about an Environment which is using a Credential. This also includes a summary of the Connection it belongs to.

environments.credentials.action.credential.usages.environment.id

string

required

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.

environments.credentials.action.credential.usages.environment.name

string

required

Name is the name of the Environment.

environments.credentials.action.credential.usages.environment.slug

string

required

Slug is the kebab-case name of the Environment.

environments.credentials.action.credential.usages.environment.connection

object

required

ConnectionSummaryBase exposes a summary of a Connection irrespective of protocol.

environments.credentials.action.credential.usages.environment.createdAt

string

required

CreatedAt is the time the Environment was created.

environments.credentials.action.credential.usages.environment.updatedAt

string

required

UpdatedAt is the time the Environment was last updated.

environments.credentials.action.credential.errors

string[]

Errors is a list of errors which occurred when attempting to validate the credential. This field may be undefined, which implies that validation has not occurred and the consumer cannot assume whether this Credential is valid or not. An empty array indicates that the Credential is valid.

environments.credentials.action.credential.data

object

required

CredentialDataNone contains no data as no credential is required to authenticate with the Connection. It is used purely as a placeholder to implement a consistent interface across all CredentialType/AuthSchemeTypes.

environments.credentials.action.credential.createdAt

string

required

CreatedAt is the time at which the Credential was created.

environments.credentials.action.credential.updatedAt

string

required

UpdatedAt is the time at which the Credential was last updated.

environments.credentials.trigger

object[]

environments.credentials.trigger.id

string

required

environments.credentials.trigger.authSchemeConfig

object

required

environments.credentials.trigger.credential

object

required

CredentialBase is the base type for all credentials. It contains the common properties which are shared across all credential types.

environments.credentials.trigger.credential.id

string

required

ID is the unique identifier of the Credential.

environments.credentials.trigger.credential.type

enum<string>

required

CredentialType denotes the type of the credential which determines what the Credential's data property will contain.

none: No credential is required to authenticate with the Connection.
string: The credential is a string value, such as an API key or password.
binary: The credential is a binary value, such as a private key, certificate or other file.
basic-auth: The credential is a username and password to be used for basic authentication.
oauth2-client: The credential is an OAuth2 client ID and secret to be used for OAuth2 authentication.
oauth2-token: The credential is an OAuth2 access_token to be used for OAuth2 authentication.

Available options:

none,

string,

binary,

basic-auth,

oauth2-client,

oauth2-token

environments.credentials.trigger.credential.name

string

required

Name is the name of the Credential.

environments.credentials.trigger.credential.usages

object[]

environments.credentials.trigger.credential.usages.environment

object

required

CredentialUsageEnvironment contains the information about an Environment which is using a Credential. This also includes a summary of the Connection it belongs to.

environments.credentials.trigger.credential.usages.environment.id

string

required

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.

environments.credentials.trigger.credential.usages.environment.name

string

required

Name is the name of the Environment.

environments.credentials.trigger.credential.usages.environment.slug

string

required

Slug is the kebab-case name of the Environment.

environments.credentials.trigger.credential.usages.environment.connection

object

required

ConnectionSummaryBase exposes a summary of a Connection irrespective of protocol.

environments.credentials.trigger.credential.usages.environment.createdAt

string

required

CreatedAt is the time the Environment was created.

environments.credentials.trigger.credential.usages.environment.updatedAt

string

required

UpdatedAt is the time the Environment was last updated.

environments.credentials.trigger.credential.errors

string[]

environments.credentials.trigger.credential.data

object

required

environments.credentials.trigger.credential.createdAt

string

required

CreatedAt is the time at which the Credential was created.

environments.credentials.trigger.credential.updatedAt

string

required

UpdatedAt is the time at which the Credential was last updated.

environments.variables

object[]

required

environments.createdAt

string

required

CreatedAt is the time the Environment was created.

environments.updatedAt

string

required

UpdatedAt is the time the Environment was last updated.

versions

object[]

Versions is a list of all the versions this Connection has.

createdAt

string

required

CreatedAt is the time at which the ConnectionVersion was created.

updatedAt

string

required

UpdatedAt is the time at which the ConnectionVersion was last updated, including any changes to child resources.

baseUrl

string

required

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

Get Connection Delete Connection

API Reference

Authorizations

Path Parameters

Body

Response