API Keys

Access your API Keys to manage to retrieve your status page information, incidents and maintenance.

StatusPal provides two types of API keys you can access to see and manage your status pages:

User API key

Your user API key allows you to manage and/or read your status pages according to your user role within a StatusPal organization.

Access your user API key by clicking on My details from the top right profile icon:

StatuPal status pages API keys for users

Organization API keys

Organization API keys grant access to all the status pages within an organization, either read-only or read-and-write.

Manage your organization's API keys by visiting your organization's settings and clicking on Security > API Keys.

StatusPal status page API keys for organization

When to use which type of API key?

Organization API keys are preferred for integrations that act on an automated basis instead of on behalf of a specific person. It is important to select the minimum necessary access, and when possible, only read-only permissions should be granted.

A user-level API key can be used when an integration should act on behalf of a specific person. Furthermore, since organization API keys don't currently support restriction to specific status pages, user API keys can be used to give access to only a subset of the status pages in an organization.

Have any thoughts about API keys? Drop us a line at support@statuspal.io.

Last updated