Create and manage API keys

API keys are managed by account owners at the organization level. Team members can view the organization and page IDs needed when using the API, but not API keys. Contact the account owners listed under API info to obtain API key information. View our developer documentation at https://developer.statuspage.io/.

View API keys

  1. Click your avatar in the bottom left of the management interface screen.

  2. Select API info from the menu that appears. Account owners see a list of organization API keys.

    • Team members see page IDs and the email address(es) of the account owner(s) to contact if they need API key information.

  3. Click Show more to see all your API keys if you have more than five.

Some of these keys may be named “Key migrated from {email address}”. These are keys that belonged to team members prior to restricting access to API keys at the organization level.

IN USE indicates API keys that have been used in the last 6 months.

Create API keys

Only account owners can create API keys.

  1. Click your avatar in the bottom left of the management interface screen.

  2. Click API info from the menu that appears.

  3. Click Create key.

  4. Enter a key name. This name appears in the activity log and in some integration messages, so you may want to give this key a descriptive name to indicate which application uses it.

  5. Click Confirm.

Your new API key is added to your list on the API info page.

Rename API keys

Only account owners can rename API keys.

  1. Click your avatar in the bottom left of the management interface screen.

  2. Click API info from the menu that appears.

  3. Find the API key you want to rename from the list of keys.

  4. Click the ••• icon to the right of the API key you want to rename.

  5. Click Rename key.

  6. Enter a key name. This name appears in the activity log and in some integration messages, so you may want to give this key a descriptive name to indicate which application uses it.

  7. Click Confirm.

Your API key’s new name is reflected 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.

  1. Click your avatar in the bottom left of the management interface screen.

  2. Click API info from the menu that appears.

  3. Find the API key you want to rename from the list of keys.

    • Note: If the key has IN USE next to it, it is currently in use for existing configured applications. You may want to replace the key before deleting it if currently in use.

  4. Click the ••• icon to the right of the API key you want to rename.

  5. Click Delete key.

  6. Click Confirm.

Your API key no longer appears on the API info page and no longer works to configure applications.

Additional Help

Ask the Community