Method: organizations.environments.updateEnvironment

Updates an existing environment.

When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the Get Environment API.

Note: Both PUT and POST methods are supported for updating an existing environment.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. Name of the environment. Use the following structure in your request: organizations/{org}/environments/{env}

Authorization requires the following IAM permission on the specified resource name:

  • apigee.environments.update

Request body

The request body contains an instance of Environment.

Response body

If successful, the response body contains an instance of Environment.

Authorization Scopes

Requires the following OAuth scope: