List API keys

Lists API keys. Requires secret:read or secret.read.

Request

GET /secret

Query Parameters

ParameterTypeDefaultDescription
_startinteger0Pagination offset.
_endinteger10End index (exclusive). Page size is _end - _start.
activeboolean—When set, filters by isActive.

Headers

HeaderValue
AuthorizationBearer <token> (or HMAC headers, see Authentication)

Response

JSON array of secret objects. X-Makaira-Total is the number of items in this page.

FieldTypeDescription
idintegerKey id.
isActivebooleanInactive keys cannot authenticate.
titlestringTitle.
descriptionstringDescription (legacy secret for the original Shared Secret).
createdBystringCreator email or Makaira.
maskedSecretstringMasked value.
plainSecretstring or nullFull key if the caller has every permission on the key.
expirystring or nullExpiry datetime.
permissionsarrayAPI permission strings.