Rotate an API key (new secret shown once)

post/v1/keys/{keyId}/rotate

Request

  • Base URL: https://api.offendersearch.app
  • URL: https://api.offendersearch.app/v1/keys/{keyId}/rotate
  • Auth: HTTP bearer

Path parameters

keyIdstring required

Response

Rotated key; new secret returned once.

idstring
namestring
maskedKeystring

Prefix + ellipsis; the full secret is never re-shown.

createdAtstring date-time
lastUsedAtstring date-time nullable
status'active' | 'revoked'
kind'secret' | 'map_publishable'

secret for an ordinary key; map_publishable for a map browser key.

allowedOriginsstring[]

The sites a map browser key may be used from. Empty for a secret key.

secretstring

Full key secret — returned ONCE on create/rotate; only its hash is stored.

Changes

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