PUT
/
o
/
{organisation_id}
/
connections
/
{connection_id}
curl --request PUT \
  --url https://platform.versori.com/api/connect/v1alpha1/o/{organisation_id}/connections/{connection_id} \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "organisationId": "<string>",
  "name": "<string>",
  "protocol": "http",
  "authSchemeConfigs": [
    {
      "schemeType": "<string>"
    }
  ],
  "environments": [
    {
      "id": "<string>",
      "name": "<string>",
      "credentials": {
        "action": [
          {
            "id": "<string>",
            "authSchemeConfig": {
              "schemeType": "<string>"
            }
          }
        ],
        "trigger": [
          {
            "id": "<string>",
            "authSchemeConfig": {
              "schemeType": "<string>"
            }
          }
        ]
      },
      "variables": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "baseUrl": "<string>",
  "environmentVariables": [
    {
      "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",
  "baseUrl": "<string>"
}

Authorizations

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

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

baseUrl
string
required

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