NOTE: Some aspects of this product are in Beta. The hybrid installation options are GA. To join the Beta program, reach out to your Apigee representative.

Method: organizations.environments.updateDebugmask

Updates the debug mask singleton resource for an environment.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Name of the debug mask.

Query parameters


string (FieldMask format)

Field debug mask to support partial updates.

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



Boolean flag that specifies whether to replace existing values in the debug mask when doing an update. Set to true to replace existing values. The default behavior is to append the values (false).

Request body

The request body contains an instance of DebugMask.

Response body

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

Authorization Scopes

Requires the following OAuth scope: