Rivier/ Reference/ keys

Replace a key with a twin; the old key keeps working for the overlap

post/keys/{id}/rotate

Before you call

Credential
Authorization: Bearer $KEY
Scope
keys:admin
Sdk
keys.key.rotate
Cli
keys key rotate
Events
keys.key.rotated

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • overlapHoursnumber
    At least 0. At most 720.

Responses

  • 201application/json
    Success
    • key_idstringrequired
    • prefixstringrequired
    • replacesstringrequired
    • old_key_expires_atstringrequired
    • secretstringrequired
  • 400application/json
    The request was malformed
    • errorstringrequired
    • messagestring
  • 401application/json
    No valid credential
    • errorstringrequired
    • messagestring
  • 403application/json
    The credential lacks the scope, origin or address
    • errorstringrequired
    • messagestring
  • 429application/json
    Over the key's rate limit; see Retry-After
    • errorstringrequired
    • messagestring

This page as Markdown