POST
/
o
/
{organisation_id}
/
protocols
/
bigquery
/
connections

Authorizations

cookie
string
cookierequired

Cookie authentication used by the Versori Platform.

Path Parameters

organisation_id
string
required

Body

application/json
name
string
required

Name is the user-provided name of the Connection

datasetId
string

DatasetID is the ID of the BigQuery dataset, in the format "<project_id>.<dataset_name>"

environments
object[]
required
environments.name
string
required

Name is the name of the Environment.

environments.credentials
object
required

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.

environments.variables
object[]
required

Response

201 - application/json
id
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.schemeType
string
required
Allowed value: "none"
environmentVariables
object[]

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

environmentVariables.name
string
required

Name is the name of the environment variable.

environmentVariables.value
string
required

Value is the value of the environment variable.

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.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.

versions.id
string
required

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.

versions.name
string
required

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.

versions.description
string

Description allows specifying additional information about the ConnectionVersion, such as what changed since the last version etc.

versions.isLatest
boolean
required

IsLatest denotes whether this is the latest version of the Connection.

versions.isDefault
boolean
required

IsDefault denotes whether this is the default version of the Connection.

versions.createdAt
string
required

CreatedAt is the time at which the ConnectionVersion was created.

versions.updatedAt
string
required

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

versions.publishedAt
string | null
required

PublishedAt is the time at which the ConnectionVersion was published.

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.

datasetId
string
required

DatasetID is the ID of the BigQuery dataset, in the format "<project_id>.<dataset_name>"