api-keys

Regenerate Key

Deprecated — use POST /api/auth/me/regenerate instead.

The path-parameter form leaks the key into Caddy/proxy access logs. The replacement reads from the X-API-Key header only.

post/api/keys/{api_key}/regenerate

Request

  • Base URL: https://api.halalterminal.com
  • URL: https://api.halalterminal.com/api/keys/{api_key}/regenerate
  • Auth: API key in header X-API-Key

Path parameters

api_keystring required

API key to deactivate and replace.

Response

The old (deactivated) key and the new replacement key

old_keystring required

The deactivated API key

new_keystring required

The newly generated replacement key

emailstring required

Email associated with the key

planstring required

Plan tier carried over to the new key

Example response

{
  "email": "dev@example.com",
  "new_key": "ht_xyz789ghi012",
  "old_key": "ht_abc123def456",
  "plan": "starter"
}

Changes

No recorded changes to this operation across all 1 revision of this API.