Skip to navigation
Product SearchKeys

Get Key

Get one key, never its secret. Takes a write key for every index. 404 KEY_NOT_FOUND for an id that doesn’t exist.

Authentication

AuthorizationBearer

A write key, issued by Captain. Server side only. Sent as Authorization: Bearer <key>.

Path parameters

key_idstringRequired

Response

key
idstringOptional
typeenumOptional
Allowed values:
prefixstringOptional
operatorstringOptional

minted by a console key: the person it was minted for, fixed. Its events record it, and a request with it may not send X-Captain-Operator

principalslist of stringsOptional
filter_exprstringOptional
max_ttlintegerOptional
issued_bystringOptional
issued_by_captainbooleanOptional

in a write key’s view: a key Captain issued (a console or support key). Its operator and description are left out, and only Captain revokes it

indexeslist of stringsOptional
filterobject or nullOptional
expires_atinteger or nullOptional
allowed_originslist of stringsOptional
descriptionstringOptional
created_atintegerOptional
keystringOptional

only in the response to POST /v1/keys