Create and manage API keys
To enhance security and safeguard our customers from possible vulnerabilities, we will deprecate existing API keys by January 31, 2026. We will also discontinue support for using api_key
in the query parameters.
We recommend generating new API keys, which can be configured to expire within a range of 1 to 365 days.
API keys are managed by account owners at the organization level. Product admin can manage the organization and page IDs needed when using the API, along with API keys. To get the API key details, please contact the account owners listed under API info. For more information, visit our developer documentation at developer.statuspage.io.
View API keys
Starting January 31, 2026, API keys will no longer be displayed. Be sure to copy your keys at the time of creation, as the ability to copy them from the API key list will be removed.
Select your avatar in the top right of the Statuspage management screen.
Select API info from the menu that appears. Account owners see a list of organization API keys.
Team members can view page IDs and the email addresses of account owners to contact for API key information.
Select Show more to see all your API keys if you have more than five.
Some keys might be named "Key migrated from {email address}." These keys were originally assigned to team members before access was restricted to the organization level.
API keys will now show a last used date and expired at date.
Create API keys
Only account owners can create API keys.
Select your avatar from the bottom left of the management screen.
Select API info from the menu that appears.
Select Create key.
Enter a key name.
This name appears in the activity log and some integration messages, so it's helpful to give the key a descriptive name to identify which application is using it.
Select the Copy icon to copy the API key to be used.
Select Confirm.
Your new API key will appear in the list on the API info page.
Rename API keys
Starting January 31, 2026, the ability to rename API keys will be discontinued with the deprecation of the old API key version. However, you will still be able to delete these keys.
Only account owners can rename API keys.
Select your avatar from the bottom left of the management screen.
Select API info from the menu that appears.
Find the API key you want to rename from the list of keys.
Select the More actions icon (•••) next to the API key you want to rename.
Select Rename key.
Enter a key name.
This name appears in the activity log and some integration messages, so it's helpful to give the key a descriptive name to identify which application is using it.
Select Confirm.
Your API key’s new name will appear in the list on the API info page.
Delete API keys
Only account owners can delete API keys. If you delete an API key, any existing applications using that key will no longer work and you’ll need to update those applications.
Select your avatar from the bottom left of the management screen.
Select API info from the menu that appears.
Find the API key you want to delete from the list of keys.
If a key is marked as IN USE, it is actively being used by existing applications. Consider replacing the key before deleting it to ensure those applications continue to function.
Select the Delete icon next to the API key you want to delete.
Select Confirm.
Was this helpful?