ApiA P I Keys

Regenerate an API key, with an overlap window

Issue a replacement and let the old key expire, rather than killing it. The old key keeps authenticating for the configured overlap window (`API_KEY_REGENERATE_OVERLAP_MINUTES`), so the new one can be rolled out without a synchronised deploy. As with creation, the plaintext appears in this response and nowhere else, ever.

POST
/api/b/v1/api-keys/{key_id}/regenerate

Issue a replacement and let the old key expire, rather than killing it.

The old key keeps authenticating for the configured overlap window (API_KEY_REGENERATE_OVERLAP_MINUTES), so the new one can be rolled out without a synchronised deploy. As with creation, the plaintext appears in this response and nowhere else, ever.

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

Path Parameters

key_id*Key Id
Formatuuid
admin_access_token?string|null

Response Body

application/json

application/json

curl -X POST "https://example.com/api/b/v1/api-keys/497f6eca-6276-4993-bfeb-53cbbbba6f08/regenerate"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "mode": "test",  "key_prefix": "string",  "scopes": [    "string"  ],  "created_at": "2019-08-24T14:15:22Z",  "last_used_at": "2019-08-24T14:15:22Z",  "revoked_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "replaced_by_id": "a3d84e0a-4d68-4aaf-98ed-4d6a393ea8e5",  "secret": "string"}

Create an API key (secret shown once) POST

Issue a key for the business in the token. The response is the only time the secret exists outside the caller's system. Afterwards only its SHA-256 digest and prefix are stored.

Revoke an API key DELETE

Revoke a key. The row remains as evidence that it existed.