- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Gets the metadata for 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
GET https://apikeys.googleapis.com/v2/{name=projects/*/locations/*/keys/*}
The URL uses gRPC Transcoding syntax.
Path parameters
name
string
Required. The resource name of the API key to get.
Authorization requires the following IAM
permission on the specified resource name
:
-
apikeys.keys.get
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Key
.
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 .
IAM Permissions
Requires the following IAM
permission on the name
resource:
-
apikeys.keys.get
For more information, see the IAM documentation .
