Update an environment

This operation modifies an exisitng environment. Once you set the environmentName and profile fields when creating an environment, you can't change them.

Path Params
string
required

Name of the workspace that unifies all resources for your application or service. You can rename the workspace with a separate operation after you initially create the resource.

string
required

Name of the environment, unique within a workspace. You can't modify it after you initially create it with a POST request.

Query Params
string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params
additionalGroupIds
array of strings
length ≥ 0

Additional groups provide a mechanism for cross-team collaboration. You can create these groups in Identity and Access Management to grant fine-grained, functional access to secondary teams. These teams can then interact with, view, or test specific components, such as individual environments or rule sets, without owning the underlying infrastructure.

additionalGroupIds
string

An optional description for the environment version to help you identify its specific purpose.

string

Name of the environment visible in the Control Center application. You can change this value without affecting the environmentName.

tags
array of strings

Keywords that describe resources, making filtering, searching, and discovery more efficient.

tags
Headers
string
^(\\W)?"

This header prevents accidental overwrites and conflicts by making requests conditional. When you pass in a resource's ETag as an If-Match test, the update succeeds only if the resource hasn't changed. If the current ETag doesn't match and the data has changed, the server responds with a 412 error. See the Concurrency control section for more details.

Response

Language
URL
LoadingLoading…
Response
Choose an example:
application/json