Docs
API keys

Read one key

GET
/v1/api-keys/{id}

Needs an admin key (fx_admin_…), made by the workspace owner in the console — or a signed-in owner or admin. Ordinary API keys are refused with ADMIN_KEY_REQUIRED.

A key's name, scopes, environment label, hint and when it was last used — never the key itself, which is shown only once, when it is created.

Authorization

adminKey
AuthorizationBearer <token>

Authorization: Bearer fx_admin_<id>_<secret>.

An admin key manages this workspace's ordinary API keys (/v1/api-keys) and can do nothing else. Only the workspace owner makes one, in the console, optionally limited to IP addresses and given an expiry. Every request made with one is audited.

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/api-keys/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "publicId": "string",    "hint": "string",    "environment": "live",    "scopes": [      "string"    ],    "lastUsedAt": null,    "expiresAt": null,    "revokedAt": null,    "createdAt": "2019-08-24T14:15:22Z",    "limits": null,    "createdBy": null,    "createdByAdminKey": null  }}