Statuspage connector

1. Install the SDK

   Node.js

   npm install @scalekit-sdk/node

   Python

   pip install scalekit

   Full SDK reference: Node.js | Python

2. Set your credentials

   Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

   .env

   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>

3. Make your first call

   Node.js

   quickstart.ts

   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   
   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENV_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions
   
   const connector = 'statuspage'
   const identifier = 'user_123'
   
   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'statuspage_component_groups_list',
     toolInput: { page_id: 'YOUR_PAGE_ID' },
   })
   console.log(result)

   Python

   quickstart.py

   import os
   from scalekit.client import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()
   
   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENV_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions
   
   connection_name = "statuspage"
   identifier = "user_123"
   
   # Make your first call
   result = actions.execute_tool(
       tool_input={"page_id":"YOUR_PAGE_ID"},
       tool_name="statuspage_component_groups_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)

What you can do

Connect this agent connector to let your agent:

• List users, templates, subscribers — Retrieve a list of team members (users) belonging to a Statuspage organization, with optional pagination
• Update user permissions, subscriber, status embed config — Update a Statuspage organization user’s role permissions
• Get user permissions, subscribers histogram by state, subscribers count — Retrieve a Statuspage organization user’s permissions, including the per-page roles (page configuration, incident manager, maintenance manager) they have been granted where Role Based Access Control is enabled
• Delete user, page access user metrics, page access user metric — Delete a user from a Statuspage organization
• Create user, template, subscriber — Create a new team member (user) in a Statuspage organization, granting them access to manage the organization’s status pages
• Bulk subscribers unsubscribe, subscribers resend confirmation, subscribers reactivate — Unsubscribe a list of subscribers from a Statuspage status page, optionally filtered by subscriber type and state, or unsubscribe all subscribers (if fewer than 100)

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

statuspage_component_create#Create a new component (a service or part of your infrastructure) on a Statuspage page, with a display name, status, description, and optional group assignment.8 params▾

Create a new component (a service or part of your infrastructure) on a Statuspage page, with a display name, status, description, and optional group assignment.

NameTypeRequiredDescription

namestringrequiredDisplay name for the component, e.g. 'API' or 'Website'.

page_idstringrequiredThe identifier of the Statuspage page to create the component on

descriptionstringoptionalMore detailed description for the component.

group_idstringoptionalIdentifier of the component group to add this component to.

only_show_if_degradedbooleanoptionalWhether to only show this component if it is degraded. Requires a special feature flag to be enabled on your account.

showcasebooleanoptionalWhether this component should be showcased on the status page.

start_datestringoptionalThe date this component started being used, in YYYY-MM-DD format.

statusstringoptionalStatus of the component. Valid values: operational, under_maintenance, degraded_performance, partial_outage, major_outage.

statuspage_component_delete#Permanently delete a component from a Statuspage status page.2 params▾

Permanently delete a component from a Statuspage status page.

NameTypeRequiredDescription

component_idstringrequiredThe identifier of the component to delete

page_idstringrequiredThe identifier of the Statuspage page the component belongs to

statuspage_component_get#Retrieve details of a single component on a Statuspage page by its component ID, including name, status, description, group, and display settings.2 params▾

Retrieve details of a single component on a Statuspage page by its component ID, including name, status, description, group, and display settings.

NameTypeRequiredDescription

component_idstringrequiredThe identifier of the component to retrieve

page_idstringrequiredThe identifier of the Statuspage page the component belongs to

statuspage_component_group_create#Create a new component group on a Statuspage status page. A component group organizes multiple components together under a single collapsible heading on the status page. Requires a name and a list of component IDs to include in the group.4 params▾

Create a new component group on a Statuspage status page. A component group organizes multiple components together under a single collapsible heading on the status page. Requires a name and a list of component IDs to include in the group.

NameTypeRequiredDescription

componentsarrayrequiredArray of component IDs to include in this group.

namestringrequiredName of the component group as it will appear on the status page.

page_idstringrequiredThe identifier of the Statuspage page to create the component group on.

descriptionstringoptionalDescription of the component group, shown to visitors of the status page.

statuspage_component_group_delete#Permanently delete a component group from a Statuspage status page.2 params▾

Permanently delete a component group from a Statuspage status page.

NameTypeRequiredDescription

idstringrequiredThe identifier of the component group to delete

page_idstringrequiredThe identifier of the Statuspage page the component group belongs to

statuspage_component_group_get#Retrieve details of a single component group on a Statuspage status page by its ID, including its name and the components it contains.2 params▾

Retrieve details of a single component group on a Statuspage status page by its ID, including its name and the components it contains.

NameTypeRequiredDescription

idstringrequiredThe identifier of the component group to retrieve

page_idstringrequiredThe identifier of the Statuspage page the component group belongs to

statuspage_component_group_update#Update an existing component group on a Statuspage status page. You can update the name, description, and the set of components included in the group.5 params▾

Update an existing component group on a Statuspage status page. You can update the name, description, and the set of components included in the group.

NameTypeRequiredDescription

idstringrequiredThe identifier of the component group to update.

page_idstringrequiredThe identifier of the Statuspage page the component group belongs to.

componentsarrayoptionalUpdated array of component IDs to include in this group. Replaces the existing set of components.

descriptionstringoptionalUpdated description of the component group, shown to visitors of the status page.

namestringoptionalUpdated name of the component group.

statuspage_component_group_uptime_get#Get uptime data for a component group that has uptime showcase enabled for at least one component. Returns aggregate uptime data over a date range (maximum six calendar months) along with related events unless skipped.5 params▾

Get uptime data for a component group that has uptime showcase enabled for at least one component. Returns aggregate uptime data over a date range (maximum six calendar months) along with related events unless skipped.

NameTypeRequiredDescription

idstringrequiredThe identifier of the component group to retrieve uptime data for.

page_idstringrequiredThe identifier of the Statuspage page the component group belongs to.

endstringoptionalThe end date for uptime calculation, e.g. '2024-06-30', '2024-06', or '2024'. Defaults to today in the page's time zone. Maximum supported range is six calendar months, earliest supported date is 1970-01-01.

skip_related_eventsbooleanoptionalIf true, skips supplying the related events data along with the component group uptime data.

startstringoptionalThe start date for uptime calculation, e.g. '2024-01-01', '2024-01', or '2024'. Defaults to the date of the earliest component start_date in the group, or 90 days ago, whichever is more recent. Maximum supported range is six calendar months, earliest supported date is 1970-01-01.

statuspage_component_groups_list#Retrieve a list of component groups on a Statuspage status page, with optional pagination.3 params▾

Retrieve a list of component groups on a Statuspage status page, with optional pagination.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page whose component groups should be listed

pagenumberoptionalThe page offset of component groups to fetch. The first page is 0, the second is 1, etc.

per_pagenumberoptionalThe number of results to return per page. Maximum and default of 100.

statuspage_component_page_access_groups_add#Grant a list of page access groups access to a specific component on a Statuspage status page.3 params▾

Grant a list of page access groups access to a specific component on a Statuspage status page.

NameTypeRequiredDescription

component_idstringrequiredThe identifier of the component to grant page access groups access to.

page_access_group_idsarrayrequiredList of page access group IDs to grant access to this component.

page_idstringrequiredThe identifier of the Statuspage page that owns the component.

statuspage_component_page_access_groups_remove#Revoke all page access groups' access from a specific component on a Statuspage status page.2 params▾

Revoke all page access groups' access from a specific component on a Statuspage status page.

NameTypeRequiredDescription

component_idstringrequiredThe identifier of the component to remove page access groups from.

page_idstringrequiredThe identifier of the Statuspage page that owns the component.

statuspage_component_page_access_users_add#Grant a list of page access users direct access to a specific component on a Statuspage status page.3 params▾

Grant a list of page access users direct access to a specific component on a Statuspage status page.

NameTypeRequiredDescription

component_idstringrequiredThe identifier of the component to grant page access users access to.

page_access_user_idsarrayrequiredList of page access user IDs to grant access to this component.

page_idstringrequiredThe identifier of the Statuspage page that owns the component.

statuspage_component_page_access_users_remove#Revoke all page access users' direct access from a specific component on a Statuspage status page.2 params▾

Revoke all page access users' direct access from a specific component on a Statuspage status page.

NameTypeRequiredDescription

component_idstringrequiredThe identifier of the component to remove page access users from.

page_idstringrequiredThe identifier of the Statuspage page that owns the component.

statuspage_component_update#Update a component on a Statuspage page, such as its name, status, description, or group assignment. If group_id is set to null, the component is removed from its group.9 params▾

Update a component on a Statuspage page, such as its name, status, description, or group assignment. If group_id is set to null, the component is removed from its group.

NameTypeRequiredDescription

component_idstringrequiredThe identifier of the component to update

page_idstringrequiredThe identifier of the Statuspage page the component belongs to

descriptionstringoptionalMore detailed description for the component.

group_idstringoptionalIdentifier of the component group to assign this component to. Set to an empty string or null to remove the component from its group.

namestringoptionalDisplay name for the component.

only_show_if_degradedbooleanoptionalWhether to only show this component if it is degraded. Requires a special feature flag to be enabled on your account.

showcasebooleanoptionalWhether this component should be showcased on the status page.

start_datestringoptionalThe date this component started being used, in YYYY-MM-DD format.

statusstringoptionalStatus of the component. Valid values: operational, under_maintenance, degraded_performance, partial_outage, major_outage.

statuspage_component_uptime_get#Get uptime data for a component that has uptime showcase enabled. Returns uptime data over a date range (maximum six calendar months) along with related events unless skipped.5 params▾

Get uptime data for a component that has uptime showcase enabled. Returns uptime data over a date range (maximum six calendar months) along with related events unless skipped.

NameTypeRequiredDescription

component_idstringrequiredThe identifier of the component to retrieve uptime data for.

page_idstringrequiredThe identifier of the Statuspage page the component belongs to.

endstringoptionalThe end date for uptime calculation, e.g. '2024-06-30', '2024-06', or '2024'. Defaults to today in the page's time zone. Maximum supported range is six calendar months, earliest supported date is 1970-01-01.

skip_related_eventsbooleanoptionalIf true, skips supplying the related events data along with the component uptime data.

startstringoptionalThe start date for uptime calculation, e.g. '2024-01-01', '2024-01', or '2024'. Defaults to the component's start_date field or 90 days ago, whichever is more recent. Maximum supported range is six calendar months, earliest supported date is 1970-01-01.

statuspage_components_list#Retrieve the list of components (services/parts of your infrastructure) configured on a Statuspage page, including their name, status, group, and description. Supports pagination.3 params▾

Retrieve the list of components (services/parts of your infrastructure) configured on a Statuspage page, including their name, status, group, and description. Supports pagination.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page whose components should be listed

pageintegeroptionalPage offset to fetch, for paginating through results. Starts at 1.

per_pageintegeroptionalNumber of results to return per page. Maximum and default limit is 100.

statuspage_incident_create#Create a new incident or scheduled maintenance on a Statuspage page. Supports realtime incidents (investigating/identified/monitoring/resolved) and scheduled maintenances (scheduled/in_progress/verifying/completed), with optional affected components, notification control, and auto-transition settings.25 params▾

Create a new incident or scheduled maintenance on a Statuspage page. Supports realtime incidents (investigating/identified/monitoring/resolved) and scheduled maintenances (scheduled/in_progress/verifying/completed), with optional affected components, notification control, and auto-transition settings.

NameTypeRequiredDescription

namestringrequiredIncident name. Maximum length of 255 characters.

page_idstringrequiredThe identifier of the Statuspage page to create the incident on

auto_transition_deliver_notifications_at_endbooleanoptionalWhether to send a notification when the scheduled maintenance automatically transitions to completed.

auto_transition_deliver_notifications_at_startbooleanoptionalWhether to send a notification when the scheduled maintenance automatically transitions to started.

auto_transition_to_maintenance_statebooleanoptionalWhether to change affected components' status to under_maintenance once the scheduled maintenance is in progress.

auto_transition_to_operational_statebooleanoptionalWhether to change affected components' status to operational once the scheduled maintenance completes.

auto_tweet_at_beginningbooleanoptionalWhether to tweet automatically when the scheduled maintenance starts.

auto_tweet_on_completionbooleanoptionalWhether to tweet automatically when the scheduled maintenance completes.

auto_tweet_on_creationbooleanoptionalWhether to tweet automatically when the scheduled maintenance is created.

auto_tweet_one_hour_beforebooleanoptionalWhether to tweet automatically one hour before the scheduled maintenance starts.

backfill_datestringoptionalTimestamp for when the incident was backfilled, in YYYY-MM-DD format.

backfilledbooleanoptionalWhether the incident is backfilled (recorded after the fact). If true, components cannot be specified.

bodystringoptionalThe initial message, created as the first incident update. Maximum length of 25000 characters.

component_idsarrayoptionalList of component IDs affected by this incident. Example: ["kctbh9vrtdwd", "lcy4z7wq3fjr"].

componentsobjectoptionalMap of component_id to new status to apply to affected components. Example: {"kctbh9vrtdwd": "degraded_performance"}. Valid statuses: operational, under_maintenance, degraded_performance, partial_outage, major_outage.

deliver_notificationsbooleanoptionalWhether to deliver notifications to subscribers. If false, the incident is created without notifying customers. Defaults to true.

impact_overridestringoptionalValue to override the calculated impact value. Valid values: none, maintenance, minor, major, critical.

metadataobjectoptionalArbitrary JSON object attached to the incident. All top-level values in the object must also be objects, e.g. {"jira": {"issue_id": "ABC-123"}}.

reminder_intervalsstringoptionalCustom reminder intervals for unresolved/open incidents (not applicable to scheduled maintenance). A serialized array of strictly increasing integers 1-24 (e.g. "[1, 5, 7, 10]"), a single integer as a string for equal intervals (e.g. "4"), or "[]" to disable reminders.

scheduled_auto_completedbooleanoptionalWhether the incident is scheduled to automatically transition to completed at its scheduled end time.

scheduled_auto_in_progressbooleanoptionalWhether the incident is scheduled to automatically transition to in_progress at its scheduled start time.

scheduled_forstringoptionalThe ISO 8601 timestamp the scheduled incident is scheduled to start.

scheduled_remind_priorbooleanoptionalWhether to remind subscribers prior to the scheduled incident starting.

scheduled_untilstringoptionalThe ISO 8601 timestamp the scheduled incident is scheduled to end.

statusstringoptionalThe incident status. For realtime incidents, valid values are investigating, identified, monitoring, and resolved. For scheduled incidents, valid values are scheduled, in_progress, verifying, and completed.

statuspage_incident_delete#Permanently delete an incident from a Statuspage status page. This action cannot be undone.2 params▾

Permanently delete an incident from a Statuspage status page. This action cannot be undone.

NameTypeRequiredDescription

incident_idstringrequiredThe identifier of the incident to delete

page_idstringrequiredThe identifier of the Statuspage page that owns the incident

statuspage_incident_get#Retrieve details of a single incident on a Statuspage page by its incident ID, including status, impact, affected components, incident updates, and postmortem information.2 params▾

Retrieve details of a single incident on a Statuspage page by its incident ID, including status, impact, affected components, incident updates, and postmortem information.

NameTypeRequiredDescription

incident_idstringrequiredThe identifier of the incident to retrieve

page_idstringrequiredThe identifier of the Statuspage page the incident belongs to

statuspage_incident_postmortem_create#Create (or replace) the draft postmortem body for a Statuspage incident.3 params▾

Create (or replace) the draft postmortem body for a Statuspage incident.

NameTypeRequiredDescription

body_draftstringrequiredBody of Postmortem to create.

incident_idstringrequiredThe identifier of the incident to create a postmortem for

page_idstringrequiredThe identifier of the Statuspage page that owns the incident

statuspage_incident_postmortem_delete#Permanently delete the postmortem report associated with a Statuspage incident. Per the Statuspage API spec, this returns HTTP 204 No Content on success.2 params▾

Permanently delete the postmortem report associated with a Statuspage incident. Per the Statuspage API spec, this returns HTTP 204 No Content on success.

NameTypeRequiredDescription

incident_idstringrequiredThe identifier of the incident whose postmortem should be deleted.

page_idstringrequiredThe identifier of the Statuspage page that owns the incident.

statuspage_incident_postmortem_get#Retrieve the postmortem for a Statuspage incident, including its draft/published body content and publish status.2 params▾

Retrieve the postmortem for a Statuspage incident, including its draft/published body content and publish status.

NameTypeRequiredDescription

incident_idstringrequiredThe identifier of the incident whose postmortem should be retrieved

page_idstringrequiredThe identifier of the Statuspage page that owns the incident

statuspage_incident_postmortem_publish#Publish the postmortem report for a Statuspage incident, making it visible on the public status page. Optionally notify e-mail subscribers, notify Twitter followers, and include a custom tweet. Per the Statuspage API spec, this returns HTTP 200 on success.5 params▾

Publish the postmortem report for a Statuspage incident, making it visible on the public status page. Optionally notify e-mail subscribers, notify Twitter followers, and include a custom tweet. Per the Statuspage API spec, this returns HTTP 200 on success.

NameTypeRequiredDescription

incident_idstringrequiredThe identifier of the incident whose postmortem should be published.

page_idstringrequiredThe identifier of the Statuspage page that owns the incident.

custom_tweetstringoptionalCustom postmortem tweet text to publish when notify_twitter is true. If omitted, a default tweet is used.

notify_subscribersbooleanoptionalWhether to notify e-mail subscribers that the postmortem has been published. Defaults to the page's configured behavior if omitted.

notify_twitterbooleanoptionalWhether to notify Twitter followers that the postmortem has been published. Defaults to the page's configured behavior if omitted.

statuspage_incident_postmortem_revert#Revert a published postmortem report for a Statuspage incident back to draft, unpublishing it from the public status page. Per the Statuspage API spec, this returns HTTP 200 on success.2 params▾

Revert a published postmortem report for a Statuspage incident back to draft, unpublishing it from the public status page. Per the Statuspage API spec, this returns HTTP 200 on success.

NameTypeRequiredDescription

incident_idstringrequiredThe identifier of the incident whose postmortem should be reverted to draft.

page_idstringrequiredThe identifier of the Statuspage page that owns the incident.

statuspage_incident_subscriber_create#Create a new subscriber (email or SMS) for notifications about a specific Statuspage incident. Provide either an email address, or a phone_country and phone_number pair for SMS. Per the Statuspage API spec, this returns HTTP 201 on success.6 params▾

Create a new subscriber (email or SMS) for notifications about a specific Statuspage incident. Provide either an email address, or a phone_country and phone_number pair for SMS. Per the Statuspage API spec, this returns HTTP 201 on success.

NameTypeRequiredDescription

incident_idstringrequiredThe identifier of the incident to subscribe to.

page_idstringrequiredThe identifier of the Statuspage page that owns the incident.

emailstringoptionalThe email address to use for creating an email subscriber. Required if phone_number is not provided.

phone_countrystringoptionalThe two-character country code (e.g. 'US') for the phone number location, used when creating an SMS subscriber.

phone_numberstringoptionalThe phone number (as dialed from phone_country) to use for creating an SMS subscriber. Required if email is not provided.

skip_confirmation_notificationbooleanoptionalIf true, the subscriber does not receive any notifications when their subscription changes; email subscribers are automatically opted in. Only available on paid pages and has no effect for trial customers.

statuspage_incident_subscriber_get#Retrieve details of a single subscriber to a specific Statuspage incident by subscriber ID.3 params▾

Retrieve details of a single subscriber to a specific Statuspage incident by subscriber ID.

NameTypeRequiredDescription

incident_idstringrequiredThe identifier of the incident that the subscriber is subscribed to.

page_idstringrequiredThe identifier of the Statuspage page that owns the incident.

subscriber_idstringrequiredThe identifier of the incident subscriber to retrieve.

statuspage_incident_subscriber_resend_confirmation#Resend the confirmation notification (email or SMS) to a pending subscriber of a specific Statuspage incident. Per the Statuspage API spec, this returns HTTP 201 on success.3 params▾

Resend the confirmation notification (email or SMS) to a pending subscriber of a specific Statuspage incident. Per the Statuspage API spec, this returns HTTP 201 on success.

NameTypeRequiredDescription

incident_idstringrequiredThe identifier of the incident the subscriber is subscribed to.

page_idstringrequiredThe identifier of the Statuspage page that owns the incident.

subscriber_idstringrequiredThe identifier of the incident subscriber to resend a confirmation notification to.

statuspage_incident_subscriber_unsubscribe#Unsubscribe a subscriber from notifications about a specific Statuspage incident. Per the Statuspage API spec, this returns HTTP 200 on success.3 params▾

Unsubscribe a subscriber from notifications about a specific Statuspage incident. Per the Statuspage API spec, this returns HTTP 200 on success.

NameTypeRequiredDescription

incident_idstringrequiredThe identifier of the incident the subscriber is subscribed to.

page_idstringrequiredThe identifier of the Statuspage page that owns the incident.

subscriber_idstringrequiredThe identifier of the incident subscriber to unsubscribe.

statuspage_incident_subscribers_list#Get a list of subscribers who are subscribed to a specific Statuspage incident. Supports pagination via page and per_page query parameters.4 params▾

Get a list of subscribers who are subscribed to a specific Statuspage incident. Supports pagination via page and per_page query parameters.

NameTypeRequiredDescription

incident_idstringrequiredThe identifier of the incident whose subscribers should be listed.

page_idstringrequiredThe identifier of the Statuspage page that owns the incident.

pageintegeroptionalThe page number of results to fetch, starting at 1. Used for pagination.

per_pageintegeroptionalThe number of results to return per page.

statuspage_incident_update#Update an existing incident or scheduled maintenance on a Statuspage page, such as changing its status, posting a new update body, adjusting affected components, or modifying scheduling/notification settings.27 params▾

Update an existing incident or scheduled maintenance on a Statuspage page, such as changing its status, posting a new update body, adjusting affected components, or modifying scheduling/notification settings.

NameTypeRequiredDescription

incident_idstringrequiredThe identifier of the incident to update

page_idstringrequiredThe identifier of the Statuspage page the incident belongs to

auto_transition_deliver_notifications_at_endbooleanoptionalWhether to send a notification when the scheduled maintenance automatically transitions to completed.

auto_transition_deliver_notifications_at_startbooleanoptionalWhether to send a notification when the scheduled maintenance automatically transitions to started.

auto_transition_to_maintenance_statebooleanoptionalWhether to change affected components' status to under_maintenance once the scheduled maintenance is in progress.

auto_transition_to_operational_statebooleanoptionalWhether to change affected components' status to operational once the scheduled maintenance completes.

auto_tweet_at_beginningbooleanoptionalWhether to tweet automatically when the scheduled maintenance starts.

auto_tweet_on_completionbooleanoptionalWhether to tweet automatically when the scheduled maintenance completes.

auto_tweet_on_creationbooleanoptionalWhether to tweet automatically when the scheduled maintenance is created.

auto_tweet_one_hour_beforebooleanoptionalWhether to tweet automatically one hour before the scheduled maintenance starts.

backfill_datestringoptionalTimestamp for when the incident was backfilled, in YYYY-MM-DD format.

backfilledbooleanoptionalWhether the incident is backfilled (recorded after the fact). If true, components cannot be specified.

bodystringoptionalThe initial message, created as the first incident update. Maximum length of 25000 characters.

component_idsarrayoptionalList of component IDs affected by this incident. Example: ["kctbh9vrtdwd", "lcy4z7wq3fjr"].

componentsobjectoptionalMap of component_id to new status to apply to affected components. Example: {"kctbh9vrtdwd": "degraded_performance"}. Valid statuses: operational, under_maintenance, degraded_performance, partial_outage, major_outage.

deliver_notificationsbooleanoptionalWhether to deliver notifications to subscribers. If false, the incident is created without notifying customers. Defaults to true.

impact_overridestringoptionalValue to override the calculated impact value. Valid values: none, maintenance, minor, major, critical.

metadataobjectoptionalArbitrary JSON object attached to the incident. All top-level values in the object must also be objects, e.g. {"jira": {"issue_id": "ABC-123"}}.

namestringoptionalIncident name. Maximum length of 255 characters.

reminder_intervalsstringoptionalCustom reminder intervals for unresolved/open incidents (not applicable to scheduled maintenance). A serialized array of strictly increasing integers 1-24 (e.g. "[1, 5, 7, 10]"), a single integer as a string for equal intervals (e.g. "4"), or "[]" to disable reminders.

scheduled_auto_completedbooleanoptionalWhether the incident is scheduled to automatically transition to completed at its scheduled end time.

scheduled_auto_in_progressbooleanoptionalWhether the incident is scheduled to automatically transition to in_progress at its scheduled start time.

scheduled_auto_transitionbooleanoptionalSame as scheduled_auto_in_progress. Controls whether the incident is scheduled to automatically change to in_progress.

scheduled_forstringoptionalThe ISO 8601 timestamp the scheduled incident is scheduled to start.

scheduled_remind_priorbooleanoptionalWhether to remind subscribers prior to the scheduled incident starting.

scheduled_untilstringoptionalThe ISO 8601 timestamp the scheduled incident is scheduled to end.

statusstringoptionalThe incident status. For realtime incidents, valid values are investigating, identified, monitoring, and resolved. For scheduled incidents, valid values are scheduled, in_progress, verifying, and completed.

statuspage_incident_update_edit#Update a previous incident update on a Statuspage status page, editing its body text, display timestamp, or the Twitter/notification delivery flags.7 params▾

Update a previous incident update on a Statuspage status page, editing its body text, display timestamp, or the Twitter/notification delivery flags.

NameTypeRequiredDescription

incident_idstringrequiredThe identifier of the incident that owns the incident update

incident_update_idstringrequiredThe identifier of the incident update to edit

page_idstringrequiredThe identifier of the Statuspage page that owns the incident

bodystringoptionalIncident update body.

deliver_notificationsbooleanoptionalControls whether to delivery notifications.

display_atstringoptionalTimestamp when incident update is happened.

wants_twitter_updatebooleanoptionalControls whether to create twitter update.

statuspage_incidents_list#Retrieve the list of incidents (including scheduled maintenances) for a Statuspage page. Supports free-text search across name, status, postmortem body, and incident updates, plus pagination.4 params▾

Retrieve the list of incidents (including scheduled maintenances) for a Statuspage page. Supports free-text search across name, status, postmortem body, and incident updates, plus pagination.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page whose incidents should be listed

limitintegeroptionalThe maximum number of rows to return per page. The default and maximum limit is 100.

pageintegeroptionalPage offset to fetch, for paginating through results. Starts at 1.

qstringoptionalSearch for this text query string in the incidents' name, status, postmortem_body, and incident_updates fields.

statuspage_incidents_list_active_maintenance#Retrieve the list of active (in-progress) scheduled maintenances for a Statuspage status page, with optional pagination controls.3 params▾

Retrieve the list of active (in-progress) scheduled maintenances for a Statuspage status page, with optional pagination controls.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page whose active maintenances should be listed

pagenumberoptionalPage offset to fetch.

per_pagenumberoptionalNumber of results to return per page.

statuspage_incidents_list_scheduled#Get a list of scheduled maintenance incidents for a Statuspage status page. Supports pagination via page and per_page query parameters.3 params▾

Get a list of scheduled maintenance incidents for a Statuspage status page. Supports pagination via page and per_page query parameters.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page whose scheduled incidents should be listed.

pageintegeroptionalThe page number of results to fetch, starting at 1. Used for pagination.

per_pageintegeroptionalThe number of results to return per page. Defaults to 100.

statuspage_incidents_list_unresolved#Retrieve the list of unresolved incidents (incidents that have not yet reached the resolved or completed state) for a Statuspage page. Supports pagination.3 params▾

Retrieve the list of unresolved incidents (incidents that have not yet reached the resolved or completed state) for a Statuspage page. Supports pagination.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page whose unresolved incidents should be listed

pageintegeroptionalPage offset to fetch, for paginating through results. Defaults to 1.

per_pageintegeroptionalNumber of results to return per page. Defaults to 100.

statuspage_incidents_list_upcoming#Get a list of upcoming (future scheduled maintenance) incidents for a Statuspage status page. Supports pagination via page and per_page query parameters.3 params▾

Get a list of upcoming (future scheduled maintenance) incidents for a Statuspage status page. Supports pagination via page and per_page query parameters.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page whose upcoming incidents should be listed.

pageintegeroptionalThe page number of results to fetch, starting at 1. Used for pagination.

per_pageintegeroptionalThe number of results to return per page. Defaults to 100.

statuspage_metric_data_add#Add a single data point to a metric on a Statuspage status page. Requires a unix timestamp and a numeric value to store against the metric.4 params▾

Add a single data point to a metric on a Statuspage status page. Requires a unix timestamp and a numeric value to store against the metric.

NameTypeRequiredDescription

metric_idstringrequiredThe identifier of the metric to add data to.

page_idstringrequiredThe identifier of the Statuspage page the metric belongs to.

timestampintegerrequiredUnix timestamp (seconds since epoch) to store the data point against.

valuenumberrequiredNumeric value of the data point to record.

statuspage_metric_data_reset#Reset (permanently delete) all historical data points for a metric on a Statuspage page, while keeping the metric configuration itself intact.2 params▾

Reset (permanently delete) all historical data points for a metric on a Statuspage page, while keeping the metric configuration itself intact.

NameTypeRequiredDescription

metric_idstringrequiredThe identifier of the metric whose data should be reset

page_idstringrequiredThe identifier of the Statuspage page that owns the metric

statuspage_metric_delete#Delete a metric from a Statuspage metric provider. This permanently removes the metric configuration and its associated data from the given page.2 params▾

Delete a metric from a Statuspage metric provider. This permanently removes the metric configuration and its associated data from the given page.

NameTypeRequiredDescription

metric_idstringrequiredThe identifier of the metric to delete

page_idstringrequiredThe identifier of the Statuspage page that owns the metric

statuspage_metric_get#Retrieve details of a single metric on a Statuspage status page by its metric ID, including its display name, data source, and configuration.2 params▾

Retrieve details of a single metric on a Statuspage status page by its metric ID, including its display name, data source, and configuration.

NameTypeRequiredDescription

metric_idstringrequiredThe identifier of the metric to retrieve

page_idstringrequiredThe identifier of the Statuspage page the metric belongs to

statuspage_metric_provider_create#Create a new metric provider on a Statuspage status page to connect an external monitoring service (Pingdom, NewRelic, Librato, Datadog, or Self) and display its metrics. Required fields vary by provider type: Librato requires email and api_token; Datadog requires api_key, api_token, and metric_base_uri; NewRelic requires api_key and metric_base_uri; Pingdom requires api_token and application_key.8 params▾

Create a new metric provider on a Statuspage status page to connect an external monitoring service (Pingdom, NewRelic, Librato, Datadog, or Self) and display its metrics. Required fields vary by provider type: Librato requires email and api_token; Datadog requires api_key, api_token, and metric_base_uri; NewRelic requires api_key and metric_base_uri; Pingdom requires api_token and application_key.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page to create the metric provider on.

typestringrequiredThe type of metrics provider to create. One of Pingdom, NewRelic, Librato, Datadog, or Self.

api_keystringoptionalAPI key credential. Required by the Datadog and NewRelic type metrics providers.

api_tokenstringoptionalAPI token credential. Required by the Librato, Datadog, and Pingdom type metrics providers.

application_keystringoptionalApplication key credential. Required by the Pingdom-type metrics provider.

emailstringoptionalAccount email address. Required by the Librato metrics provider.

metric_base_uristringoptionalBase URI for the metrics provider's API. Required by the Datadog and NewRelic type metrics providers.

passwordstringoptionalAccount password for the metrics provider, if required by that provider type.

statuspage_metric_provider_delete#Delete a metric provider from a Statuspage page. This permanently removes the provider integration and all metrics associated with it.2 params▾

Delete a metric provider from a Statuspage page. This permanently removes the provider integration and all metrics associated with it.

NameTypeRequiredDescription

metrics_provider_idstringrequiredThe identifier of the metric provider to delete

page_idstringrequiredThe identifier of the Statuspage page that owns the metric provider

statuspage_metric_provider_get#Get details of a specific metric provider configured on a Statuspage status page, including its type, base URI, and revalidation timestamps.2 params▾

Get details of a specific metric provider configured on a Statuspage status page, including its type, base URI, and revalidation timestamps.

NameTypeRequiredDescription

metrics_provider_idstringrequiredThe identifier of the metric provider to retrieve.

page_idstringrequiredThe identifier of the Statuspage page the metric provider belongs to.

statuspage_metric_provider_metric_create#Create a new metric for a metric provider on a Statuspage page. Use this to add a custom or provider-pulled metric (e.g. from Pingdom, NewRelic, Librato, Datadog) that will render as a graph on the status page.13 params▾

Create a new metric for a metric provider on a Statuspage page. Use this to add a custom or provider-pulled metric (e.g. from Pingdom, NewRelic, Librato, Datadog) that will render as a graph on the status page.

NameTypeRequiredDescription

metrics_provider_idstringrequiredThe identifier of the metric provider under which to create the metric

namestringrequiredName of the metric to display on the graph

page_idstringrequiredThe identifier of the Statuspage page that owns the metric provider

application_idstringoptionalThe identifier for the New Relic application. Required only when the metric provider type is NewRelic

decimal_placesintegeroptionalHow many decimal places to render on the graph

displaybooleanoptionalWhether the metric should be displayed on the status page

metric_identifierstringoptionalThe identifier used to look up the metric data from the provider (provider-specific, e.g. a Pingdom check ID or NewRelic metric name)

suffixstringoptionalSuffix to describe the units on the graph, e.g. ms, %, req/s

tooltip_descriptionstringoptionalDescription text shown in the graph tooltip

transformstringoptionalThe transform to apply to the metric before pulling it into Statuspage. One of: average, count, max, min, or sum

y_axis_hiddenbooleanoptionalWhether the values on the y axis should be hidden when rendering the graph

y_axis_maxintegeroptionalThe upper bound of the y axis on the graph

y_axis_minintegeroptionalThe lower bound of the y axis on the graph

statuspage_metric_provider_metrics_list#List the metrics associated with a specific metric provider on a Statuspage status page, with optional pagination controls.4 params▾

List the metrics associated with a specific metric provider on a Statuspage status page, with optional pagination controls.

NameTypeRequiredDescription

metrics_provider_idstringrequiredThe identifier of the metric provider whose metrics should be listed

page_idstringrequiredThe identifier of the Statuspage page that owns the metric provider

pagenumberoptionalPage offset to fetch. Beginning February 28, 2023, this endpoint will return paginated data even if this query parameter is not provided.

per_pagenumberoptionalNumber of results to return per page. Beginning February 28, 2023, a default and maximum limit of 100 will be imposed.

statuspage_metric_provider_update#Update an existing metric provider (e.g. Pingdom, NewRelic, Librato, Datadog) on a Statuspage page. Only the provider type and metric base URI can be updated.4 params▾

Update an existing metric provider (e.g. Pingdom, NewRelic, Librato, Datadog) on a Statuspage page. Only the provider type and metric base URI can be updated.

NameTypeRequiredDescription

metrics_provider_idstringrequiredThe identifier of the metric provider to update

page_idstringrequiredThe identifier of the Statuspage page that owns the metric provider

metric_base_uristringoptionalThe base URI used to query metric data from the provider, if applicable

typestringoptionalThe type of the metrics provider integration, e.g. Pingdom, NewRelic, Librato, Datadog, Statuspage, Custom, Self

statuspage_metric_providers_list#Get a list of all metric providers configured on a Statuspage status page. Metric providers connect external monitoring services (e.g. Pingdom, NewRelic, Librato, Datadog) to display performance metrics on the status page.1 param▾

Get a list of all metric providers configured on a Statuspage status page. Metric providers connect external monitoring services (e.g. Pingdom, NewRelic, Librato, Datadog) to display performance metrics on the status page.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page to list metric providers for.

statuspage_metric_update#Update an existing metric on a Statuspage status page. You can update the display name and the metric identifier used to look up data from the provider.4 params▾

Update an existing metric on a Statuspage status page. You can update the display name and the metric identifier used to look up data from the provider.

NameTypeRequiredDescription

metric_idstringrequiredThe identifier of the metric to update.

page_idstringrequiredThe identifier of the Statuspage page the metric belongs to.

metric_identifierstringoptionalUpdated metric display identifier used to look up the metric data from the provider.

namestringoptionalUpdated display name of the metric.

statuspage_metrics_data_add_batch#Add data points to one or more metrics on a Statuspage status page in a single request. Provide a data object keyed by metric ID, where each value is an array of {timestamp, value} data points. The submission is queued and processed asynchronously by Statuspage.2 params▾

Add data points to one or more metrics on a Statuspage status page in a single request. Provide a data object keyed by metric ID, where each value is an array of {timestamp, value} data points. The submission is queued and processed asynchronously by Statuspage.

NameTypeRequiredDescription

dataobjectrequiredObject mapping metric IDs to arrays of data points, each with a unix timestamp and numeric value. Example: {"vq23nrtrsy1j": [{"timestamp": 1783078513, "value": 123.456}]}

page_idstringrequiredThe identifier of the Statuspage page the metrics belong to.

statuspage_metrics_list#Retrieve a list of metrics configured on a Statuspage status page, with optional pagination.3 params▾

Retrieve a list of metrics configured on a Statuspage status page, with optional pagination.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page whose metrics should be listed

pagenumberoptionalThe page offset of metrics to fetch. The first page is 0, the second is 1, etc.

per_pagenumberoptionalThe number of results to return per page. Maximum and default of 100.

statuspage_page_access_group_component_remove#Remove a single component from a page access group on a Statuspage status page, identified by page ID, page access group ID, and component ID.3 params▾

Remove a single component from a page access group on a Statuspage status page, identified by page ID, page access group ID, and component ID.

NameTypeRequiredDescription

component_idstringrequiredThe identifier of the component to remove from the page access group.

page_access_group_idstringrequiredThe identifier of the page access group to remove the component from.

page_idstringrequiredThe identifier of the Statuspage page that owns the page access group.

statuspage_page_access_group_components_add#Add one or more components to a page access group's visibility on a Statuspage status page. Existing components already assigned to the group remain, and the provided component IDs are added alongside them.3 params▾

Add one or more components to a page access group's visibility on a Statuspage status page. Existing components already assigned to the group remain, and the provided component IDs are added alongside them.

NameTypeRequiredDescription

component_idsarrayrequiredList of component IDs to add to this page access group's visibility.

page_access_group_idstringrequiredThe identifier of the page access group to add components to.

page_idstringrequiredThe identifier of the Statuspage page the access group belongs to.

statuspage_page_access_group_components_delete#Delete a specified list of components from a page access group on a Statuspage status page. Only the listed component IDs are removed; any other components already assigned to the group are left unchanged.3 params▾

Delete a specified list of components from a page access group on a Statuspage status page. Only the listed component IDs are removed; any other components already assigned to the group are left unchanged.

NameTypeRequiredDescription

component_idsarrayrequiredThe list of component IDs to remove from the page access group.

page_access_group_idstringrequiredThe identifier of the page access group to remove components from.

page_idstringrequiredThe identifier of the Statuspage page that owns the page access group.

statuspage_page_access_group_components_list#Retrieve the list of components a page access group has visibility into on a Statuspage status page.2 params▾

Retrieve the list of components a page access group has visibility into on a Statuspage status page.

NameTypeRequiredDescription

page_access_group_idstringrequiredThe identifier of the page access group to list components for.

page_idstringrequiredThe identifier of the Statuspage page the access group belongs to.

statuspage_page_access_group_components_replace#Replace the full set of components assigned to a page access group on a Statuspage status page. This overwrites the existing component list for the group with the provided list of component IDs.3 params▾

Replace the full set of components assigned to a page access group on a Statuspage status page. This overwrites the existing component list for the group with the provided list of component IDs.

NameTypeRequiredDescription

component_idsarrayrequiredThe full list of component IDs to set on the page access group. This replaces any previously assigned components.

page_access_group_idstringrequiredThe identifier of the page access group whose components should be replaced.

page_idstringrequiredThe identifier of the Statuspage page that owns the page access group.

statuspage_page_access_group_create#Create a new page access group on a Statuspage status page. Page access groups bundle components, metrics, and page access users together, letting you build audience-specific status pages.6 params▾

Create a new page access group on a Statuspage status page. Page access groups bundle components, metrics, and page access users together, letting you build audience-specific status pages.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page to create the access group on.

component_idsarrayoptionalList of component IDs this page access group should have visibility into.

external_identifierstringoptionalAssociates the group with an external group, such as an SSO/IdP group identifier.

metric_idsarrayoptionalList of metric IDs this page access group should have visibility into.

namestringoptionalName for this page access group.

page_access_user_idsarrayoptionalList of page access user IDs to add to this group.

statuspage_page_access_group_delete#Permanently remove a page access group from a Statuspage status page. This deletes the group itself; it does not delete the underlying components, metrics, or page access users.2 params▾

Permanently remove a page access group from a Statuspage status page. This deletes the group itself; it does not delete the underlying components, metrics, or page access users.

NameTypeRequiredDescription

page_access_group_idstringrequiredThe identifier of the page access group to remove.

page_idstringrequiredThe identifier of the Statuspage page the access group belongs to.

statuspage_page_access_group_get#Retrieve details of a single page access group on a Statuspage status page, including its name, associated components, metrics, and page access users.2 params▾

Retrieve details of a single page access group on a Statuspage status page, including its name, associated components, metrics, and page access users.

NameTypeRequiredDescription

page_access_group_idstringrequiredThe identifier of the page access group to retrieve.

page_idstringrequiredThe identifier of the Statuspage page the access group belongs to.

statuspage_page_access_group_update#Update a page access group on a Statuspage status page, including its name, external identifier, and the components, metrics, and page access users it grants visibility into.7 params▾

Update a page access group on a Statuspage status page, including its name, external identifier, and the components, metrics, and page access users it grants visibility into.

NameTypeRequiredDescription

page_access_group_idstringrequiredThe identifier of the page access group to update.

page_idstringrequiredThe identifier of the Statuspage page the access group belongs to.

component_idsarrayoptionalList of component IDs this page access group should have visibility into. Replaces the existing set.

external_identifierstringoptionalAssociates the group with an external group, such as an SSO/IdP group identifier.

metric_idsarrayoptionalList of metric IDs this page access group should have visibility into. Replaces the existing set.

namestringoptionalName for this page access group.

page_access_user_idsarrayoptionalList of page access user IDs in this group. Replaces the existing set.

statuspage_page_access_groups_list#Retrieve a paginated list of page access groups configured for a Statuspage status page. Page access groups bundle components, metrics, and page access users together for audience-specific status pages.3 params▾

Retrieve a paginated list of page access groups configured for a Statuspage status page. Page access groups bundle components, metrics, and page access users together for audience-specific status pages.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page to list page access groups for.

pageintegeroptionalPage offset to fetch. As of February 28, 2023, this endpoint returns paginated data even if this parameter is not provided.

per_pageintegeroptionalNumber of results to return per page. As of February 28, 2023, a default and maximum limit of 100 is imposed.

statuspage_page_access_user_component_remove#Remove a single component from a page access user's allowed components on a Statuspage status page.3 params▾

Remove a single component from a page access user's allowed components on a Statuspage status page.

NameTypeRequiredDescription

component_idstringrequiredThe identifier of the component to remove access to

page_access_user_idstringrequiredThe identifier of the page access user to remove the component from

page_idstringrequiredThe identifier of the Statuspage page the access user belongs to

statuspage_page_access_user_components_add#Grant a page access user access to additional components on a Statuspage status page, without affecting components they already have access to.3 params▾

Grant a page access user access to additional components on a Statuspage status page, without affecting components they already have access to.

NameTypeRequiredDescription

component_idsarrayrequiredList of component codes to grant access to, in addition to existing access

page_access_user_idstringrequiredThe identifier of the page access user to grant component access to

page_idstringrequiredThe identifier of the Statuspage page the access user belongs to

statuspage_page_access_user_components_list#Retrieve the list of components that a page access user has access to on a Statuspage status page.4 params▾

Retrieve the list of components that a page access user has access to on a Statuspage status page.

NameTypeRequiredDescription

page_access_user_idstringrequiredThe identifier of the page access user to fetch components for

page_idstringrequiredThe identifier of the Statuspage page the access user belongs to

pageintegeroptionalPage offset to fetch

per_pageintegeroptionalNumber of results to return per page

statuspage_page_access_user_components_remove#Remove a page access user's access to a specific set of components on a Statuspage status page. Components not listed remain accessible.3 params▾

Remove a page access user's access to a specific set of components on a Statuspage status page. Components not listed remain accessible.

NameTypeRequiredDescription

component_idsarrayrequiredList of component codes to revoke access to

page_access_user_idstringrequiredThe identifier of the page access user to remove component access from

page_idstringrequiredThe identifier of the Statuspage page the access user belongs to

statuspage_page_access_user_components_replace#Replace the full set of components a page access user has access to on a Statuspage status page. Any components not included in the list will be removed from the user's access.3 params▾

Replace the full set of components a page access user has access to on a Statuspage status page. Any components not included in the list will be removed from the user's access.

NameTypeRequiredDescription

component_idsarrayrequiredList of component codes the user should have exclusive access to

page_access_user_idstringrequiredThe identifier of the page access user whose component access will be replaced

page_idstringrequiredThe identifier of the Statuspage page the access user belongs to

statuspage_page_access_user_create#Add a page access user to a Statuspage status page, optionally granting access to specific page access groups and subscribing them to components.5 params▾

Add a page access user to a Statuspage status page, optionally granting access to specific page access groups and subscribing them to components.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page to add the access user to

emailstringoptionalEmail address of the page access user

external_loginstringoptionalIDP login user id for the page access user

page_access_group_idsarrayoptionalList of page access group ids to associate with this user

subscribe_to_componentsbooleanoptionalWhether to subscribe this user to component notifications

statuspage_page_access_user_delete#Permanently delete a page access user from a Statuspage status page. This removes the user's access entirely.2 params▾

Permanently delete a page access user from a Statuspage status page. This removes the user's access entirely.

NameTypeRequiredDescription

page_access_user_idstringrequiredThe identifier of the page access user to delete

page_idstringrequiredThe identifier of the Statuspage page the access user belongs to

statuspage_page_access_user_get#Retrieve details of a specific page access user on a Statuspage page, including their email, external login, and associated page access group IDs.2 params▾

Retrieve details of a specific page access user on a Statuspage page, including their email, external login, and associated page access group IDs.

NameTypeRequiredDescription

page_access_user_idstringrequiredThe identifier of the page access user to retrieve

page_idstringrequiredThe identifier of the Statuspage page that the page access user belongs to

statuspage_page_access_user_metric_delete#Remove a single metric from a page access user's visibility on a Statuspage status page.3 params▾

Remove a single metric from a page access user's visibility on a Statuspage status page.

NameTypeRequiredDescription

metric_idstringrequiredThe identifier of the metric to remove from this page access user's visibility.

page_access_user_idstringrequiredThe identifier of the page access user whose metric will be removed.

page_idstringrequiredThe identifier of the Statuspage page the access user belongs to.

statuspage_page_access_user_metrics_add#Grant a page access user access to additional metrics on a Statuspage status page, without affecting metrics they already have access to.3 params▾

Grant a page access user access to additional metrics on a Statuspage status page, without affecting metrics they already have access to.

NameTypeRequiredDescription

metric_idsarrayrequiredList of metric ids to grant access to, in addition to existing access

page_access_user_idstringrequiredThe identifier of the page access user to grant metric access to

page_idstringrequiredThe identifier of the Statuspage page the access user belongs to

statuspage_page_access_user_metrics_delete#Remove one or more metrics from a page access user's visibility on a Statuspage status page. Only the specified metric IDs are removed; other assigned metrics remain unaffected.3 params▾

Remove one or more metrics from a page access user's visibility on a Statuspage status page. Only the specified metric IDs are removed; other assigned metrics remain unaffected.

NameTypeRequiredDescription

metric_idsarrayrequiredList of metric IDs to remove from this page access user's visibility.

page_access_user_idstringrequiredThe identifier of the page access user whose metrics will be removed.

page_idstringrequiredThe identifier of the Statuspage page the access user belongs to.

statuspage_page_access_user_metrics_list#Retrieve the list of metrics that a page access user has access to on a Statuspage status page.4 params▾

Retrieve the list of metrics that a page access user has access to on a Statuspage status page.

NameTypeRequiredDescription

page_access_user_idstringrequiredThe identifier of the page access user to fetch metrics for

page_idstringrequiredThe identifier of the Statuspage page the access user belongs to

pageintegeroptionalPage offset to fetch

per_pageintegeroptionalNumber of results to return per page

statuspage_page_access_user_metrics_replace#Replace the full set of metrics visible to a page access user on a Statuspage status page. This overwrites any previously assigned metrics with the provided list of metric IDs.3 params▾

Replace the full set of metrics visible to a page access user on a Statuspage status page. This overwrites any previously assigned metrics with the provided list of metric IDs.

NameTypeRequiredDescription

metric_idsarrayrequiredThe full list of metric IDs this page access user should have access to. Replaces any existing metric assignments.

page_access_user_idstringrequiredThe identifier of the page access user whose metrics will be replaced.

page_idstringrequiredThe identifier of the Statuspage page the access user belongs to.

statuspage_page_access_user_update#Update an existing page access user on a Statuspage status page, including their external login, email, or page access group memberships.5 params▾

Update an existing page access user on a Statuspage status page, including their external login, email, or page access group memberships.

NameTypeRequiredDescription

page_access_user_idstringrequiredThe identifier of the page access user to update

page_idstringrequiredThe identifier of the Statuspage page the access user belongs to

emailstringoptionalEmail address of the page access user

external_loginstringoptionalIDP login user id for the page access user

page_access_group_idsarrayoptionalList of page access group ids to associate with this user

statuspage_page_access_users_list#Retrieve a paginated list of page access users for a Statuspage page. Page access users are subscribers who can log in to view private components or restricted pages.4 params▾

Retrieve a paginated list of page access users for a Statuspage page. Page access users are subscribers who can log in to view private components or restricted pages.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page to list page access users for

emailstringoptionalEmail address to search for among page access users

pageintegeroptionalPage offset to fetch for pagination

per_pageintegeroptionalNumber of results to return per page. As of February 28, 2023, the API imposes a default and maximum of 100

statuspage_page_get#Retrieve details of a Statuspage status page by its page ID, including name, domain, subdomain, URL, branding, and subscriber notification settings.1 param▾

Retrieve details of a Statuspage status page by its page ID, including name, domain, subdomain, URL, branding, and subscriber notification settings.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page to retrieve

statuspage_page_update#Update settings for a Statuspage status page, including name, domain, subdomain, URL, branding template, CSS theme colors, subscriber notification options, and time zone.29 params▾

Update settings for a Statuspage status page, including name, domain, subdomain, URL, branding template, CSS theme colors, subscriber notification options, and time zone.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page to update

allow_email_subscribersbooleanoptionalWhether your users can choose to receive notifications via email.

allow_incident_subscribersbooleanoptionalWhether your users can subscribe to notifications for a single incident.

allow_page_subscribersbooleanoptionalWhether your users can subscribe to all notifications on the page.

allow_rss_atom_feedsbooleanoptionalWhether your users can access incident feeds via RSS/Atom. Not functional on Audience-Specific pages.

allow_sms_subscribersbooleanoptionalWhether your users can choose to receive notifications via SMS.

allow_webhook_subscribersbooleanoptionalWhether your users can choose to receive notifications via webhooks.

brandingstringoptionalThe main template your statuspage will use. Valid values are basic and premium.

css_bluesstringoptionalCSS color used for informational elements.

css_body_background_colorstringoptionalCSS color for the page body background, e.g. a hex value like #fff.

css_border_colorstringoptionalCSS color used for borders throughout the page.

css_font_colorstringoptionalCSS color for the primary font color, e.g. a hex value like #333.

css_graph_colorstringoptionalCSS color used for uptime graphs.

css_greensstringoptionalCSS color used to represent operational/healthy status.

css_light_font_colorstringoptionalCSS color for the light/secondary font color.

css_link_colorstringoptionalCSS color used for hyperlinks on the page.

css_no_datastringoptionalCSS color used when there is no uptime data available.

css_orangesstringoptionalCSS color used to represent partial outage status.

css_redsstringoptionalCSS color used to represent major outage status.

css_yellowsstringoptionalCSS color used to represent degraded performance status.

domainstringoptionalCNAME alias for your status page

hidden_from_searchbooleanoptionalWhether your page should hide itself from search engines.

namestringoptionalName of your page to be displayed

notifications_email_footerstringoptionalCustomize the footer appearing on your notification emails. Accepts Markdown for formatting.

notifications_from_emailstringoptionalCustomize the email address your page notifications come from.

subdomainstringoptionalSubdomain at which to access your status page

time_zonestringoptionalTimezone configured for your page.

urlstringoptionalWebsite of your page. Clicking on your statuspage image will link here.

viewers_must_be_team_membersbooleanoptionalWhether only team members can view the page.

statuspage_status_embed_config_get#Retrieve the status embed config settings for a Statuspage status page, including the iframe position and its background/text colors for incident and maintenance states.1 param▾

Retrieve the status embed config settings for a Statuspage status page, including the iframe position and its background/text colors for incident and maintenance states.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page whose status embed config should be retrieved

statuspage_status_embed_config_update#Update the status embed config settings for a Statuspage status page, including the iframe corner position and background/text colors for incident and maintenance states.6 params▾

Update the status embed config settings for a Statuspage status page, including the iframe corner position and background/text colors for incident and maintenance states.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page whose status embed config should be updated

incident_background_colorstringoptionalColor of status embed iframe background when displaying incident

incident_text_colorstringoptionalColor of status embed iframe text when displaying incident

maintenance_background_colorstringoptionalColor of status embed iframe background when displaying maintenance

maintenance_text_colorstringoptionalColor of status embed iframe text when displaying maintenance

positionstringoptionalCorner where status embed iframe will appear on page

statuspage_subscriber_create#Create a new subscriber on a Statuspage status page. Supports email, SMS, and webhook subscriber types (not applicable for Slack subscribers, which cannot be created via API). Provide 'email' for email or webhook contact, 'endpoint' for webhook URL, or 'phone_country' + 'phone_number' for SMS. Optionally scope the subscription to specific components and/or a page access user.8 params▾

Create a new subscriber on a Statuspage status page. Supports email, SMS, and webhook subscriber types (not applicable for Slack subscribers, which cannot be created via API). Provide 'email' for email or webhook contact, 'endpoint' for webhook URL, or 'phone_country' + 'phone_number' for SMS. Optionally scope the subscription to specific components and/or a page access user.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page to add the subscriber to

component_idsarrayoptionalA list of component IDs the subscriber should receive updates for. Must contain at least one element if provided; each component must belong to the page indicated by page_id. Omit to subscribe to all components.

emailstringoptionalThe email address for creating an Email subscriber, or the contact email for a Webhook subscriber. Required for email-type subscribers.

endpointstringoptionalThe endpoint URI for creating a Webhook subscriber. Required when creating a webhook-type subscriber.

page_access_userstringoptionalThe code of the page access user to which the subscriber belongs, scoping the subscription to that user's permitted components.

phone_countrystringoptionalThe two-character country code where the phone number is located, used when creating an SMS subscriber (e.g. 'US'). Required together with phone_number for SMS subscribers.

phone_numberstringoptionalThe phone number (as you would dial from phone_country) to use for the new SMS subscriber. Required together with phone_country for SMS subscribers.

skip_confirmation_notificationbooleanoptionalIf true, the subscriber does not receive any notification when their subscription changes; email subscribers are automatically opted in. Only available for paid pages, and has no effect for trial customers.

statuspage_subscriber_get#Retrieve details of a single subscriber on a Statuspage status page by its subscriber ID, including contact information, type, and state.2 params▾

Retrieve details of a single subscriber on a Statuspage status page by its subscriber ID, including contact information, type, and state.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page the subscriber belongs to

subscriber_idstringrequiredThe identifier of the subscriber to retrieve

statuspage_subscriber_resend_confirmation#Resend the confirmation email or notification to a single unconfirmed subscriber on a Statuspage status page.2 params▾

Resend the confirmation email or notification to a single unconfirmed subscriber on a Statuspage status page.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page the subscriber belongs to

subscriber_idstringrequiredThe identifier of the subscriber to resend the confirmation to

statuspage_subscriber_unsubscribe#Unsubscribe a single subscriber from a Statuspage status page by page ID and subscriber ID.3 params▾

Unsubscribe a single subscriber from a Statuspage status page by page ID and subscriber ID.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page the subscriber belongs to

subscriber_idstringrequiredThe identifier of the subscriber to unsubscribe

skip_unsubscription_notificationbooleanoptionalIf true, the subscriber does not receive any notifications when they are unsubscribed

statuspage_subscriber_update#Update a subscriber's component subscriptions on a Statuspage status page. Replaces the list of component IDs the subscriber receives updates for. Omit component_ids to subscribe the subscriber to all components on the page.3 params▾

Update a subscriber's component subscriptions on a Statuspage status page. Replaces the list of component IDs the subscriber receives updates for. Omit component_ids to subscribe the subscriber to all components on the page.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page the subscriber belongs to

subscriber_idstringrequiredThe identifier of the subscriber to update

component_idsarrayoptionalA list of component IDs the subscriber should receive updates for. Must contain at least one element if provided; each component must belong to the page indicated by page_id. Omit this parameter to subscribe the subscriber to all components on the page.

statuspage_subscribers_count_get#Retrieve a count of subscribers on a Statuspage status page, optionally filtered by subscriber type and state.3 params▾

Retrieve a count of subscribers on a Statuspage status page, optionally filtered by subscriber type and state.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page to count subscribers for

statestringoptionalIf present, only count subscribers in this state. Specify "all" to count subscribers in any state.

typestringoptionalIf present, only count subscribers of this type

statuspage_subscribers_histogram_by_state_get#Retrieve a histogram of subscribers on a Statuspage status page, broken down by subscriber type and then by state (active, unconfirmed, quarantined).1 param▾

Retrieve a histogram of subscribers on a Statuspage status page, broken down by subscriber type and then by state (active, unconfirmed, quarantined).

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page to retrieve the subscriber histogram for

statuspage_subscribers_list#Retrieve a list of subscribers for a Statuspage status page, with optional filtering by contact search text, subscriber type, and state, plus pagination and sorting controls.8 params▾

Retrieve a list of subscribers for a Statuspage status page, with optional filtering by contact search text, subscriber type, and state, plus pagination and sorting controls.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page whose subscribers should be listed

limitnumberoptionalThe maximum number of subscribers to return. If a search query (q) is specified, the default and maximum limit is 100.

pagenumberoptionalThe zero-based page offset of subscribers to fetch. The first page is 0, the second is 1, etc.

qstringoptionalSearch text to match against subscriber contact information (email, endpoint, or phone number). Not supported for Slack subscribers.

sort_directionstringoptionalThe sort direction of the listing: asc or desc.

sort_fieldstringoptionalThe field to sort by: 'primary' for the identifying field, 'created_at' for creation timestamp, 'quarantined_at' for quarantine timestamp, or 'relevance' (only valid with a search query).

statestringoptionalFilter to only return subscribers in this state. Use 'all' to return subscribers in any state. Defaults to active.

typestringoptionalFilter to only return subscribers of this type. One of email, sms, webhook, slack, teams, integration_partner.

statuspage_subscribers_list_unsubscribed#Retrieve a paginated list of unsubscribed subscribers for a Statuspage status page.3 params▾

Retrieve a paginated list of unsubscribed subscribers for a Statuspage status page.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page to list unsubscribed subscribers for

pagenumberoptionalPage offset to fetch

per_pagenumberoptionalNumber of results to return per page

statuspage_subscribers_reactivate_bulk#Reactivate a list of quarantined subscribers on a Statuspage status page, optionally filtered by subscriber type, or reactivate all quarantined subscribers.3 params▾

Reactivate a list of quarantined subscribers on a Statuspage status page, optionally filtered by subscriber type, or reactivate all quarantined subscribers.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page the subscribers belong to

subscribersarrayrequiredList of quarantined subscriber codes to reactivate, or a single-element array containing "all" to reactivate all quarantined subscribers

typestringoptionalIf present, only reactivate subscribers of this type

statuspage_subscribers_resend_confirmation_bulk#Resend confirmation notifications to a list of unconfirmed subscribers on a Statuspage status page, or to all unconfirmed email subscribers.2 params▾

Resend confirmation notifications to a list of unconfirmed subscribers on a Statuspage status page, or to all unconfirmed email subscribers.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page the subscribers belong to

subscribersarrayrequiredList of subscriber codes to resend confirmations for, or a single-element array containing "all" to resend to all unconfirmed email subscribers

statuspage_subscribers_unsubscribe_bulk#Unsubscribe a list of subscribers from a Statuspage status page, optionally filtered by subscriber type and state, or unsubscribe all subscribers (if fewer than 100).5 params▾

Unsubscribe a list of subscribers from a Statuspage status page, optionally filtered by subscriber type and state, or unsubscribe all subscribers (if fewer than 100).

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page the subscribers belong to

subscribersarrayrequiredList of subscriber codes to unsubscribe (limited to 100), or a single-element array containing "all" to unsubscribe all subscribers if the total is under 100

skip_unsubscription_notificationbooleanoptionalIf true, the subscribers do not receive any notifications when they are unsubscribed

statestringoptionalIf present, only unsubscribe subscribers in this state. Specify "all" to unsubscribe subscribers in any state.

typestringoptionalIf present, only unsubscribe subscribers of this type

statuspage_template_create#Create a new incident template on a Statuspage status page. Templates pre-fill the name, title, body, status, notification, and affected component settings when creating an incident or maintenance.9 params▾

Create a new incident template on a Statuspage status page. Templates pre-fill the name, title, body, status, notification, and affected component settings when creating an incident or maintenance.

NameTypeRequiredDescription

bodystringrequiredThe initial message, created as the first incident or maintenance update.

namestringrequiredName of the template, as shown in the list on the "Templates" tab of the "Incidents" page

page_idstringrequiredThe identifier of the Statuspage page on which to create the template

titlestringrequiredTitle to be applied to the incident or maintenance when selecting this template

component_idsarrayoptionalList of component_ids affected by this incident

group_idstringoptionalIdentifier of Template Group this template belongs to

should_send_notificationsbooleanoptionalWhether the "deliver notifications" checkbox should be selected when selecting this template

should_tweetbooleanoptionalWhether the "tweet update" checkbox should be selected when selecting this template

update_statusstringoptionalThe status the incident or maintenance should transition to when selecting this template

statuspage_templates_list#Retrieve the list of incident templates configured on a Statuspage status page, with optional pagination controls.3 params▾

Retrieve the list of incident templates configured on a Statuspage status page, with optional pagination controls.

NameTypeRequiredDescription

page_idstringrequiredThe identifier of the Statuspage page whose templates should be listed

pagenumberoptionalPage offset to fetch.

per_pagenumberoptionalNumber of results to return per page.

statuspage_user_create#Create a new team member (user) in a Statuspage organization, granting them access to manage the organization's status pages.5 params▾

Create a new team member (user) in a Statuspage organization, granting them access to manage the organization's status pages.

NameTypeRequiredDescription

emailstringrequiredEmail address for the new team member. This is the address they will use to sign in.

organization_idstringrequiredThe identifier of the Statuspage organization to add the user to

first_namestringoptionalFirst name of the new team member.

last_namestringoptionalLast name of the new team member.

passwordstringoptionalPassword the new team member will use to access the site. If omitted, Statuspage will prompt the user to set one via an invitation email.

statuspage_user_delete#Delete a user from a Statuspage organization. This permanently removes the user's access to the organization and its pages.2 params▾

Delete a user from a Statuspage organization. This permanently removes the user's access to the organization and its pages.

NameTypeRequiredDescription

organization_idstringrequiredThe identifier of the Statuspage organization that the user belongs to

user_idstringrequiredThe identifier of the user to delete

statuspage_user_permissions_get#Retrieve a Statuspage organization user's permissions, including the per-page roles (page configuration, incident manager, maintenance manager) they have been granted where Role Based Access Control is enabled.2 params▾

Retrieve a Statuspage organization user's permissions, including the per-page roles (page configuration, incident manager, maintenance manager) they have been granted where Role Based Access Control is enabled.

NameTypeRequiredDescription

organization_idstringrequiredThe identifier of the Statuspage organization that the user belongs to

user_idstringrequiredThe identifier of the user whose permissions should be retrieved

statuspage_user_permissions_update#Update a Statuspage organization user's role permissions. Provide a mapping of page IDs to the desired roles (page_configuration, incident_manager, maintenance_manager) for pages that have Role Based Access Control; pages should map to an empty object otherwise. Any page omitted from the payload will have its access revoked for this user.3 params▾

Update a Statuspage organization user's role permissions. Provide a mapping of page IDs to the desired roles (page_configuration, incident_manager, maintenance_manager) for pages that have Role Based Access Control; pages should map to an empty object otherwise. Any page omitted from the payload will have its access revoked for this user.

NameTypeRequiredDescription

organization_idstringrequiredThe identifier of the Statuspage organization that the user belongs to

pagesobjectrequiredMapping of page IDs to role objects. Each key is a page_id; each value is an object with optional boolean fields page_configuration, incident_manager, maintenance_manager (only applicable for pages with Role Based Access Control; use an empty object {} for pages without RBAC). Pages omitted from this object will have the user's access to them revoked. Example: {"p216nvklg7p5": {"page_configuration": false, "incident_manager": true, "maintenance_manager": true}}

user_idstringrequiredThe identifier of the user whose permissions should be updated

statuspage_users_list#Retrieve a list of team members (users) belonging to a Statuspage organization, with optional pagination.3 params▾

Retrieve a list of team members (users) belonging to a Statuspage organization, with optional pagination.

NameTypeRequiredDescription

organization_idstringrequiredThe identifier of the Statuspage organization whose users should be listed

pagenumberoptionalThe page offset of users to fetch. The first page is 0, the second is 1, etc.

per_pagenumberoptionalThe number of results to return per page. Maximum and default of 100.