Prerequisites: a Developer Portal account with at least one API key. If you don’t have one yet, see Get an API Key.
Your keys
The API Keys page lists every key of your organization, newest first. Each row shows the key’s name, ID, creation date and status (Active or Disabled).- The key marked Current key is your organization’s newest working key, the same one for every member. A new key you create takes its place.
- An older key that still works is marked Replaced by the current key. It keeps working until you revoke it. This only tells you which key is newer: if you use separate keys for different environments, keep a note of which key ID each one uses before you revoke anything.
- Select the eye icon to show a working key’s value, or the copy button to copy it. Every working key stays readable here until you revoke it, up to 60 reveals or copies an hour for keys other than your current key. Past that, the portal answers
Too many attempts. Try again later.until the hour is up. A disabled key never shows a value.
Rotate a key
1
Create a new key
On the API Keys page, select Create new key, then Issue new key. The new key gets the same access as your current key. If one of your keys is marked Current key, the new key takes that place.The confirmation shows the new key’s value. Copy it now and store it safely: this dialog shows it only once. You can copy it again later from the key’s row while it is active.
2
Move your traffic
Update every application, environment and stored secret to use the new key. The old key keeps working, so you can switch over at your own pace. Until you revoke it, both keys work and share your organization’s quota.
3
Revoke the old key
Select Revoke on the old key’s row, check the key name and ID in the confirmation, then select Revoke key. Requests using that key start failing. This cannot be undone.
Quota and rate limits are shared
All keys of your organization share your plan’s monthly quota and rate limit. A second key adds no allowance: requests made with any of your keys count against the same limits. When the shared limit is reached, the API returns429 Too Many Requests whichever key you use. See Rate Limits and Errors.
Select View usage on the API Keys page to see your organization’s usage. While you hold more than one key, use it for your remaining allowance: the API Usage endpoint’s remaining and limit can describe a single key’s quota, not the organization’s.
Limits
- Five working keys per organization. At five, Create new key is unavailable until you revoke one.
- Five new-key attempts per hour per account. An attempt that times out or fails after reaching Webacy still counts. Past that, the portal answers
Too many attempts. Try again later.until the hour is up. - You can’t revoke your only working key. Create a new key first, then revoke the old one.
If you can’t rotate or revoke a key
If Create new key or Revoke is not offered for a key, or the portal asks you to contact support, email info@webacy.com with the key ID (never the full key) and we will rotate or revoke it for you.Who can rotate and revoke keys
Anyone signed in to a Developer Portal account that belongs to your organization can create, reveal, copy and revoke its keys. Role-based permissions are not available yet, so every member of the organization can manage every key.What’s Next
Authentication
Learn how to send your API key with each request
