Method: projects.locations.apis.patch

Used to modify a specified API.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
api.name

string

Resource name.

Query parameters

Parameters
updateMask

string (FieldMask format)

The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request.

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

allowMissing

boolean

If set to true, and the API is not found, a new API will be created. In this situation, updateMask is ignored.

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:

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