- HTTP request
- Path parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
- Try it!
Get the key string for an API key.
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/*}/keyString
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
name |
Required. The resource name of the API key to be retrieved. Authorization requires the following IAM permission on the specified resource
|
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.getKeyString method.
| JSON representation |
|---|
{ "keyString": string } |
| Fields | |
|---|---|
keyString |
An encrypted and signed value of the key. |
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platform.read-onlyhttps://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.getKeyString
For more information, see the IAM documentation.