Skip to main content
POST
Python (SDK)

Authorizations

portal_session
string
cookie
required

Browser session cookie for the Customer Portal. Set by portal.exchangeSession and sent automatically by the browser on portal.* requests. Portal sessions are scoped to a single end user (external identity) and can only access the portal.* routes.

Body

application/json
keyId
string
required

The database identifier of the key to reroll.

This is the unique ID returned when creating or listing keys, NOT the actual API key token. You can find this ID in:

  • The response from keys.createKey
  • Key verification responses
  • The Unkey dashboard
  • API key listing endpoints
Required string length: 3 - 255
Pattern: ^[a-zA-Z0-9_]+$
Example:

"key_2cGKbMxRyIzhCxo1Idjz8q"

expiration
integer<int64>
required

Duration in milliseconds until the ORIGINAL key is revoked, starting from now.

This parameter controls the overlap period for key rotation:

  • Set to 0 to revoke the original key immediately
  • Positive values keep the original key active for the specified duration
  • Allows graceful migration by giving users time to update their credentials

Common overlap periods:

  • Immediate revocation: 0
  • 1 hour grace period: 3600000
  • 24 hours grace period: 86400000
  • 7 days grace period: 604800000
  • 30 days grace period: 2592000000
Required range: 0 <= x <= 4102444800000
Example:

86400000

Response

Key rerolled successfully. The new plaintext key is returned exactly once.

meta
object
required

Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The requestId is particularly important when troubleshooting issues with the Unkey support team.

data
object
required
Last modified on July 23, 2026