GuidesAPI Reference
API Reference

Retrieve API Key by user

Retrieves API key of the application.


Access Control:

  • The calling principal must have "read" action permission for the resource "{app}" in the "account" service.
  • The calling principal MUST NOT include a project scope.
Path Params
string
required

HRN identifying the application. Must be URL-encoded, if reserved characters ":/?#[]@!$&'()*+,;=" are used. see https://tools.ietf.org/html/rfc3986#section-2.2.

string
required

HRN with obfuscated apiKeyId. Must be URL-encoded, if reserved characters ":/?#[]@!$&'()*+,;=" are used. see https://tools.ietf.org/html/rfc3986#section-2.2.

Headers
string

Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response.

string

The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services.

Responses

401
  • 401300 - Access is denied due to invalid credentials.
404
  • 404660 - No app exists with the given id.
  • 404666 - The API key does not exist
429
  • 429003 - Request blocked because of too many requests made. Wait for a while before making a new request.
Language
Credentials
Bearer
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json