- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
- Try it!
Patches the modifiable fields of an API key. The key string of the API key isn't included in the response.
NOTE: Key is a global resource; hence the only supported value for location is global
.
HTTP request
PATCH https://apikeys.googleapis.com/v2/{key.name=projects/*/locations/*/keys/*}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
key.name |
Output only. The resource name of the key. The NOTE: Key is a global resource; hence the only supported value for location is |
Query parameters
Parameters | |
---|---|
updateMask |
The field mask specifies which fields to be updated as part of this request. All other fields are ignored. Mutable fields are: This is a comma-separated list of fully qualified names of fields. Example: |
Request body
The request body contains an instance of Key
.
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.
IAM Permissions
Requires the following IAM permission on the name
resource:
apikeys.keys.update
For more information, see the IAM documentation.