Skip to main content
POST
Rotate API key

Authorizations

Authorization
string
header
required

JWT token authentication

Headers

NexSpace-Version
string

Pin the request to a dated API version (e.g. 2026-05-10). Applied by app-level middleware to every /api route (server/routes/index.ts → apiVersionMiddleware), which echoes the resolved value back in the NexSpace-Version response header. Omit to get the latest version. Discover the catalog at GET /.well-known/api-versions.

Pattern: ^\d{4}-\d{2}-\d{2}$
Idempotency-Key
string

Replay guard for write requests. Applied by app-level middleware to every /api route (server/routes/index.ts → idempotencyMiddleware), which only acts on POST/PUT/PATCH — GET, DELETE and OPTIONS ignore the header. Re-sending the same key with an identical body within 24 hours replays the original response; the same key with a different body returns 409.

Maximum string length: 255

Path Parameters

id
integer
required

Response

New key issued (old key valid for 24h grace period)

id
integer
name
string
prefix
string

Token prefix (e.g. nex_live_, nex_test_, nex_pat_)

lastFour
string

Last 4 characters of the token

scopes
string[]
facilityId
integer | null
ipAllowlist
string[]
rateLimitPerMin
integer
lastUsedAt
string<date-time> | null
expiresAt
string<date-time> | null
revokedAt
string<date-time> | null
rotationGraceUntil
string<date-time> | null
createdAt
string<date-time>
key
string
deprecated
object