Method: projects.locations.keys.delete

Stay organized with collections Save and categorize content based on your preferences.

Deletes an API key. Deleted key can be retrieved within 30 days of deletion. Afterward, key will be purged from the project.

NOTE: Key is a global resource; hence the only supported value for location is global.

HTTP request

DELETE https://apikeys.googleapis.com/v2/{name=projects/*/locations/*/keys/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the API key to be deleted.

Authorization requires the following IAM permission on the specified resource name:

  • apikeys.keys.delete

Query parameters

Parameters
etag

string

Optional. The etag known to the client for the expected state of the key. This is to be used for optimistic concurrency.

Request body

The request body must be empty.

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

For more information, see the IAM documentation.