For AI agents and LLMs: a structured documentation index is available at /llms.txt. Every page has a Markdown sibling — append .md to any URL. To search these docs, send a GET request to https://paddle-docs-retrieval.kapa-paddle.workers.dev/?q=<question> with a URL-encoded question. No authentication needed.

Skip to content
Paddle Docs home

api_key_rotation.created

Occurs when an API key is rotated.

Occurs when an API key is rotated and a new secret is issued. The payload doesn't include the new secret.

The rotation starts as pending. api_key_rotation.updated occurs when the new secret is used for the first time, or when a newer rotation replaces it.

Use this event to spot rotations you didn't start yourself.

event_idstringrequired
Example: evt_01gks14ge726w50ch2tmaw2a1x
Unique Paddle ID for this event, prefixed with evt_.
Pattern: ^evt_[a-z\d]{26}$
event_typestringrequired
Type of event sent by Paddle, in the format entity.event_type.
Values
+ Show all values
occurred_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this event occurred.
notification_idstringrequired
Example: ntf_01ghbkd0frb9k95cnhwd1bxpvk
Unique Paddle ID for this notification, prefixed with ntf_.
Pattern: ^ntf_[a-z\d]{26}$
dataobjectrequired
New or changed entity.
idstringrequired
Example: apkrot_01gm106t81w94gyjgsaqypkjkl
Unique Paddle ID for this API key rotation entity, prefixed with apkrot_.
Pattern: ^apkrot_[a-z\d]{26}$
api_key_idstringrequired
Example: apikey_01gm106t81w94gyjgsaqypkjkl
Unique Paddle ID for this API key entity, prefixed with apikey_.
Pattern: ^apikey_[a-z\d]{26}$
statusstringrequired
Status of this API key rotation.
Values
  • pending
    Rotation was created and the new secret was issued, but it hasn't been used yet. The current secret still works.
  • completed
    The new secret was used and is now active. The old secret works until expires_at.
  • canceled
    Rotation was canceled or replaced by a newer rotation before the new secret was used.
grace_period_secondsintegerrequired
How long, in seconds, the old secret keeps working after the new secret is activated. The new secret is activated the first time it's used to authenticate a request. Set to 0 to stop the old secret working as soon as the new one is activated.
Range: 0–86400
new_key_expires_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when the API key should expire after this rotation. Applied when the new secret is activated. If omitted, the API key keeps its current expiry.
expires_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when the old secret stops working. null until the new secret is activated.
created_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
updated_atstring (date-time)required
Example: 2024-10-13T07:20:50.52Z
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
api_key_rotation.created
{
  "event_id": "evt_01jkdr0rc527wcjdg1txsdxhtk",
  "event_type": "api_key_rotation.created",
  "occurred_at": "2025-08-19T12:58:38.746382Z",
  "notification_id": "ntf_01jkdr1mgbe62eqkh3p0fq8b0s",
  "data": {
    "id": "apkrot_01jkas9tppn3bhadwpcyag45zd",
    "api_key_id": "apikey_01jkdpbhazdpn3wpcya45as9tg",
    "status": "pending",
    "grace_period_seconds": 3600,
    "new_key_expires_at": null,
    "expires_at": null,
    "created_at": "2025-08-19T12:58:38.746382Z",
    "updated_at": "2025-08-19T12:58:38.746382Z"
  }
}

Was this page helpful?