Skip to main content
GET
Retrieve an API key.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Path Parameters

shortKeyId
string
required

Required opaque short API-key identifier. Normal listed values are a six-character suffix; no route constraint or default is declared.

Response

Returns the current user's API-key record, or a null body when the key is missing or not owned by the caller.

API-key details returned by the key lookup operation.

$type
enum<string>
required
Available options:
Derivitec.Aws.ApiGateway.Models.DerivitecApiKey, Derivitec.Aws.ApiGateway
id
string | null

Opaque identifier for the API-key record.

name
string | null

Client-provided name assigned to the API key.

Example:

"Reporting integration"

value
string | null

API-key value returned by the detail operation.