Docs
API keys

Read one key

GET
/v1/api-keys/{id}

Authorization

apiKey
AuthorizationBearer <token>

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

A key is shown once, at creation. We cannot show it again or recover it for you. Keys carry an environment (live or test) in the key itself, so a test key pasted into a production config fails immediately instead of at the worst possible moment.

Scopes are per key. A key without accounts:write can read accounts and nothing else.

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"  }}

List this workspace's keys GET

Newest first, revoked keys included — a revocation is history worth seeing.

Rename or re-scope a key PATCH

New scopes replace the old ones and apply from the key's next request. The key itself does not change, so nothing using it needs redeploying. A revoked key cannot be changed.