- Switchboard API
- Connect API
- connections
- GETList Connections
- GETGet Connection
- PUTUpdate Connection
- DELDelete Connection
- GETList Connection Environments
- GETGet Environment
- PUTUpdate Environment
- DELDelete Environment
- GETList Connection Versions
- POSTCreate Connection Version
- GETGet Connection Version
- PUTUpdate Connection Version
- DELDelete Connection Version
- POSTCreate HTTP Connection
- POSTImport HTTP Connection
- POSTCreate BigQuery Connection
- GET
- connection
- actions
- definitions
- credentials
- protocols
- auth-schemes
API Reference
Create BigQuery Connection
CreateBigQueryConnection creates a new BigQuery Connection. By default the Connection will be created in a draft state and will need to be published before it can be used by other Versori products.
Cookie authentication used by the Versori Platform.
BigQueryConnectionCreate is the input to the CreateBigQueryConnection endpoint.
Name is the user-provided name of the Connection
DatasetID is the ID of the BigQuery dataset, in the format "<project_id>.<dataset_name>"
Authorizations
Cookie authentication used by the Versori Platform.
Path Parameters
Body
Name is the user-provided name of the Connection
DatasetID is the ID of the BigQuery dataset, in the format "<project_id>.<dataset_name>"
Name is the name of the Environment.
EnvironmentCredentialsCreate defines the Action and Trigger credentials for the owning Connection.
This supports defining multiple credentials for each type, which 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.
This object can either define a reference to an existing Credential via the InferredReference object, or it can define a new Credential via the CredentialCreate object.
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.
CredentialCreateOrReference is a union type which can be used to create a new Credential or reference an existing Credential.
Name is the name of the Credential.
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.
none, string, binary, basic-auth, oauth2-client, oauth2-token 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.
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.
CredentialCreateOrReference is a union type which can be used to create a new Credential or reference an existing Credential.
Name is the name of the Credential.
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.
none, string, binary, basic-auth, oauth2-client, oauth2-token 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.
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 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.
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.
CredentialBase is the base type for all credentials. It contains the common properties which are shared across all credential types.
ID is the unique identifier of the Credential.
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.
none, string, binary, basic-auth, oauth2-client, oauth2-token Name is the name of the Credential.
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.
CredentialUsageEnvironment contains the information about an Environment which is using a Credential. This also includes a summary of the Connection it belongs to.
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.
Slug is the kebab-case name of the Environment.
ConnectionSummaryBase exposes a summary of a Connection irrespective of protocol.
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 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.
CreatedAt is the time the Environment was created.
UpdatedAt is the time the Environment was last updated.
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.
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.
CreatedAt is the time at which the Credential was created.
UpdatedAt is the time at which the Credential was last updated.
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.
CredentialBase is the base type for all credentials. It contains the common properties which are shared across all credential types.
ID is the unique identifier of the Credential.
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.
none, string, binary, basic-auth, oauth2-client, oauth2-token Name is the name of the Credential.
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.
CredentialUsageEnvironment contains the information about an Environment which is using a Credential. This also includes a summary of the Connection it belongs to.
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.
Slug is the kebab-case name of the Environment.
ConnectionSummaryBase exposes a summary of a Connection irrespective of protocol.
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 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.
CreatedAt is the time the Environment was created.
UpdatedAt is the time the Environment was last updated.
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.
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.
CreatedAt is the time at which the Credential was created.
UpdatedAt is the time at which the Credential was last updated.
Name is the name of the environment variable.
Value is the value of the environment variable.
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.
DatasetID is the ID of the BigQuery dataset, in the format "<project_id>.<dataset_name>"