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

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.

environment_id
string
required

Body

application/json
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.

name
string
required

Name is the new name of the Environment.

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.

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.

Response

200 - application/json
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.

name
string
required

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

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.

variables
object[]
required
createdAt
string
required

CreatedAt is the time the Environment was created.

updatedAt
string
required

UpdatedAt is the time the Environment was last updated.