Update Environment

PUT {{apiPath}}/environments/{{envID}}

To update the configuration of your environment, you can use PUT /environments/{{envID}} to modify the attributes of the specified environment. The sample shows an update to the name and description attributes.

Note: The environment's region attribute cannot be modified in a PUT request. The region attribute value is defined when the environment resource is created (POST request) and cannot be changed.

Prerequisites

• See Environments for important overview information.

For property descriptions, see Environments data model.

Request Body

{"name"=>"Updated-Environment-Name", "region"=>"NA", "type"=>"SANDBOX", "description"=>"Updated Description", "billOfMaterials"=>{"products"=>[{"type"=>"PING_ONE_BASE", "description"=>"New environment product description", "console"=>{"href"=>"https://example.com"}}]}}