Method: projects.locations.tensorboards.experiments.runs.patch

Updates a TensorboardRun.

HTTP request

PATCH https://{service-endpoint}/v1beta1/{}

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

Path parameters



Output only. name of the TensorboardRun. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

Query parameters


string (FieldMask format)

Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the updateMask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.

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 TensorboardRun.

Response body

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

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:

  • aiplatform.tensorboardRuns.update

For more information, see the IAM documentation.