Method: organizations.locations.workloads.patch

Updates an existing workload. Currently allows updating of workload displayName and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.

HTTP request

PATCH https://{endpoint}/v1beta1/{*/locations/*/workloads/*}

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

The URLs use gRPC Transcoding syntax.

Path parameters



Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload}


Query parameters


string (FieldMask format)

Required. The list of fields to 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 Workload.

Response body

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

Authorization scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • assuredworkloads.workload.update

For more information, see the IAM documentation.