Method: projects.locations.apis.patch

Update an API resource in the API hub. The following fields in the [API][] can be updated:

The updateMask should be used to specify the fields being updated.

Updating the owner field requires complete owner message and updates both owner and email fields.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Identifier. The name of the API resource in the API Hub.

Format: projects/{project}/locations/{location}/apis/{api}

Query parameters


string (FieldMask format)

Required. The list of fields to update.

This is a comma-separated list of fully qualified names of fields. Example: "display_name,attributes".

Request body

The request body contains an instance of Api.

Response body

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

Authorization scopes

Requires the following OAuth scope:


IAM Permissions

Requires the following IAM permission on the name resource:

  • apihub.apis.update

For more information, see the IAM documentation.