API Keys

Rotate API key

Issues a replacement key and puts the old one into a grace window, during which both authenticate. The replacement is shown only once. Default window is 24 hours; pass gracePeriodHours=0 to cut the old key off immediately after a suspected leak.

post/api/v1/projects/{projectId}/api-keys/{apiKeyId}/rotate

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/projects/{projectId}/api-keys/{apiKeyId}/rotate
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

projectIdstring uuid required
apiKeyIdstring uuid required

Request body

gracePeriodHoursinteger
expiresAtstring date-time

Response

Replacement key created; the old key is retiring

Changes

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