Method: projects.locations.agents.environments.patch

Updates the specified Environment.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

HTTP request

PATCH https://{endpoint}/v3/{*/locations/*/agents/*/environments/*}

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters



The name of the environment. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

Query parameters


string (FieldMask format)

Required. The mask to control which fields get updated.

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 one of the following OAuth scopes:


For more information, see the Authentication Overview.