StatusPal
StatusPal.ioBlog
Documentation
Documentation
  • Introduction
  • Get Started
    • Key concepts
    • Step 1 - Configure services
    • Step 2 - Add your team
    • Step 3 - Personalize design
    • Step 4 - Enable notifications
    • Step 5 - Report an incident
  • Next Steps
  • FAQ
  • 1-Click Import
    • Atlassian Statuspage Importer
    • Status.io Importer (beta)
  • Platform
    • Services/components
      • Dependencies
    • Subscriptions & Notifications
      • Subscriptions
      • Notifications
      • Auto-maintenance notifications
      • Subscription Groups
      • Import email subscribers
      • Auto-subscribe to private status page
      • Custom email templates
        • Template examples
    • Incidents & Maintenance
      • Reporting an Incident
      • The Uptime Calendar Page
      • Custom Incident Types
      • Exporting your incidents
    • Information Notices
    • Private Status Page
      • Adding people to your status page
      • Access Groups/Audience Specific
    • Team Members
    • Status Page Settings & Design
      • Custom Domain
      • Advanced Settings
      • Design Customization
        • Design recipes
    • Multi-Language
    • Status Badge & Banner Widget
    • Integrations
      • Terraform
      • Datadog Metrics
      • Zoom Notifications
      • Google Analytics
      • Google Calendar
      • SendGrid Email Notifications
      • PagerDuty + Statuspal status page
      • Configure SSO for your status page with Okta
      • Configure SSO for your status page with Auth0
      • Configure your Mailgun Integration
      • Configure SMS Notifications (Twilio Integration)
      • Zabbix
      • Pingdom
      • Checkly
      • New Relic
      • Datadog
      • BetterUptime
  • Monitoring & automation
    • Out-of-the-box monitoring
    • Incident automation
    • Recurring maintenance
  • Security
    • Single Sign-On
      • Save your Recovery Codes
      • Configure Role provisioning from SAML attributes
      • Configure role provisioning for Okta
    • API Keys
Powered by GitBook
On this page
  • User API key
  • Organization API keys
  • When to use which type of API key?
  1. Security

API Keys

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

PreviousConfigure role provisioning for Okta

Last updated 9 months ago

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:

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.

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
StatuPal status pages API keys for users
StatusPal status page API keys for organization