Method: keys.lookupKey

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

Find the parent project and resource name of the API key that matches the key string in the request. If the API key has been purged, resource name will not be set. The service account must have the apikeys.keys.lookup permission on the parent project.

HTTP request

GET https://apikeys.googleapis.com/v2/keys:lookupKey

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
keyString

string

Required. Finds the project that owns the key string value.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for keys.lookupKey method.

JSON representation
{
  "parent": string,
  "name": string
}
Fields
parent

string

The project that owns the key with the value specified in the request.

name

string

The resource name of the API key. If the API key has been purged, resource name is empty.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.