Method: organizations.environments.modifyEnvironment

Stay organized with collections Save and categorize content based on your preferences.

Updates properties for an Apigee environment with patch semantics using a field mask.

Note: Not supported for Apigee hybrid.

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/{environment}.

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

  • apigee.environments.update

Query parameters


string (FieldMask format)

List of fields to be updated. Fields that can be updated: nodeConfig.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Environment.

Response body

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

Authorization Scopes

Requires the following OAuth scope: