Method: projects.agentPools.patch

Updates an existing agent pool resource.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. Specifies a unique string that identifies the agent pool.

Format: projects/{projectId}/agentPools/{agentPoolId}

Query parameters


string (FieldMask format)

The field mask of the fields in agentPool to update in this request. The following agentPool fields can be 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 AgentPool.

Response body

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

Authorization Scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.