Update Environment - Versori User Documentation

PUT

{organisation_id}

connections

{connection_id}

environments

{environment_id}

Authorizations

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

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

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.

credentials.action

object[]

credentials.action.id

string

required

credentials.action.authSchemeConfig

object

required

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.

credentials.action.credential

object

required

CredentialBase is the base type for all credentials. It contains the common properties which are shared across all credential types.

credentials.action.credential.id

string

required

ID is the unique identifier of the Credential.

credentials.action.credential.type

enum<string>

required

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.

Available options:

none,

string,

binary,

basic-auth,

oauth2-client,

oauth2-token

credentials.action.credential.name

string

required

Name is the name of the Credential.

credentials.action.credential.usages

object[]

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.

credentials.action.credential.usages.environment

object

required

CredentialUsageEnvironment contains the information about an Environment which is using a Credential. This also includes a summary of the Connection it belongs to.

credentials.action.credential.errors

string[]

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.

credentials.action.credential.data

object

required

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.

credentials.action.credential.createdAt

string

required

CreatedAt is the time at which the Credential was created.

credentials.action.credential.updatedAt

string

required

UpdatedAt is the time at which the Credential was last updated.

credentials.trigger

object[]

credentials.trigger.id

string

required

credentials.trigger.authSchemeConfig

object

required

credentials.trigger.credential

object

required

CredentialBase is the base type for all credentials. It contains the common properties which are shared across all credential types.

credentials.trigger.credential.id

string

required

ID is the unique identifier of the Credential.

credentials.trigger.credential.type

enum<string>

required

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.

Available options:

none,

string,

binary,

basic-auth,

oauth2-client,

oauth2-token

credentials.trigger.credential.name

string

required

Name is the name of the Credential.

credentials.trigger.credential.usages

object[]

credentials.trigger.credential.usages.environment

object

required

CredentialUsageEnvironment contains the information about an Environment which is using a Credential. This also includes a summary of the Connection it belongs to.

credentials.trigger.credential.errors

string[]

credentials.trigger.credential.data

object

required

credentials.trigger.credential.createdAt

string

required

CreatedAt is the time at which the Credential was created.

credentials.trigger.credential.updatedAt

string

required

UpdatedAt is the time at which the Credential was last updated.

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.

Get Environment Delete Environment

API Reference

Authorizations

Path Parameters

Body

Response