Method: projects.locations.apis.patch

Updates the parameters of a single Api.

HTTP request

PATCH https://apigateway.googleapis.com/v1/{api.name=projects/*/locations/*/apis/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
api.name

string

Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api}

Query parameters

Parameters
updateMask

string (FieldMask format)

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

A comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Api.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.