POST
/
o
/
{organisation_id}
/
protocols
/
bigquery
/
connections
curl --request POST \
  --url https://platform.versori.com/api/connect/v1alpha1/o/{organisation_id}/protocols/bigquery/connections \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "datasetId": "<string>",
  "environments": [
    {
      "name": "<string>",
      "credentials": {
        "action": [
          {
            "authSchemeConfig": {
              "schemeType": "<string>"
            },
            "credential": {
              "name": "<string>",
              "type": "none",
              "data": {}
            }
          }
        ],
        "trigger": [
          {
            "authSchemeConfig": {
              "schemeType": "<string>"
            },
            "credential": {
              "name": "<string>",
              "type": "none",
              "data": {}
            }
          }
        ]
      },
      "variables": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    }
  ]
}'
{
  "id": "<string>",
  "organisationId": "<string>",
  "name": "<string>",
  "protocol": "http",
  "authSchemeConfigs": [
    {
      "schemeType": "<string>"
    }
  ],
  "environmentVariables": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "environments": [
    {
      "id": "<string>",
      "name": "<string>",
      "credentials": {
        "action": [
          {
            "id": "<string>",
            "authSchemeConfig": {
              "schemeType": "<string>"
            },
            "credential": {
              "id": "<string>",
              "type": "none",
              "name": "<string>",
              "usages": [
                {
                  "environment": {
                    "id": "<string>",
                    "name": "<string>",
                    "slug": "<string>",
                    "connection": {
                      "id": "<string>",
                      "organisationId": "<string>",
                      "name": "<string>",
                      "protocol": "http",
                      "createdAt": "2023-11-07T05:31:56Z",
                      "updatedAt": "2023-11-07T05:31:56Z"
                    },
                    "createdAt": "2023-11-07T05:31:56Z",
                    "updatedAt": "2023-11-07T05:31:56Z"
                  }
                }
              ],
              "errors": [
                "<string>"
              ],
              "data": {},
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            }
          }
        ],
        "trigger": [
          {
            "id": "<string>",
            "authSchemeConfig": {
              "schemeType": "<string>"
            },
            "credential": {
              "id": "<string>",
              "type": "none",
              "name": "<string>",
              "usages": [
                {
                  "environment": {
                    "id": "<string>",
                    "name": "<string>",
                    "slug": "<string>",
                    "connection": {
                      "id": "<string>",
                      "organisationId": "<string>",
                      "name": "<string>",
                      "protocol": "http",
                      "createdAt": "2023-11-07T05:31:56Z",
                      "updatedAt": "2023-11-07T05:31:56Z"
                    },
                    "createdAt": "2023-11-07T05:31:56Z",
                    "updatedAt": "2023-11-07T05:31:56Z"
                  }
                }
              ],
              "errors": [
                "<string>"
              ],
              "data": {},
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            }
          }
        ]
      },
      "variables": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "versions": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "isLatest": true,
      "isDefault": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "publishedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "datasetId": "<string>"
}

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

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

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.

datasetId
string
required

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