The Statuspage connector lets your AI agent act in each user's Statuspage account. Each user connects their own Statuspage API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 99 tools.
- Tools
- 99
- What they doRead · write · destructive
- 38 · 39 · 2238 read39 write22 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. 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>Create the Statuspage connection
In AgentKit > Connections, create a Statuspage connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'statuspage'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Statuspage:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'statuspage_pages_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "statuspage"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Statuspage:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="statuspage_pages_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Statuspage credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolstatuspage_component_getRetrieve details of a single component on a Statuspage page by its component ID, including name, status, description, group, and display settings.Read-onlyGet Component
Retrieve details of a single component on a Statuspage page by its component ID, including name, status, description, group, and display settings.
Inputs
component_idstringrequired- The identifier of the component to retrieve
page_idstringrequired- The identifier of the Statuspage page the component belongs to
statuspage_component_group_getRetrieve details of a single component group on a Statuspage status page by its ID, including its name and the components it contains.Read-onlyGet Component Group
Retrieve details of a single component group on a Statuspage status page by its ID, including its name and the components it contains.
Inputs
idstringrequired- The identifier of the component group to retrieve
page_idstringrequired- The identifier of the Statuspage page the component group belongs to
statuspage_component_group_uptime_getGet uptime data for a component group that has uptime showcase enabled for at least one component.Read-onlyGet Component Group Uptime
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.
Inputs
idstringrequired- The identifier of the component group to retrieve uptime data for.
page_idstringrequired- The identifier of the Statuspage page the component group belongs to.
endstring- The 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_eventsboolean- If true, skips supplying the related events data along with the component group uptime data.
startstring- The 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_listRetrieve a list of component groups on a Statuspage status page, with optional pagination.Read-onlyList Component Groups
Retrieve a list of component groups on a Statuspage status page, with optional pagination.
Inputs
page_idstringrequired- The identifier of the Statuspage page whose component groups should be listed
pagenumber- The page offset of component groups to fetch. The first page is 0, the second is 1, etc.
per_pagenumber- The number of results to return per page. Maximum and default of 100.
statuspage_component_uptime_getGet uptime data for a component that has uptime showcase enabled.Read-onlyGet Component Uptime
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.
Inputs
component_idstringrequired- The identifier of the component to retrieve uptime data for.
page_idstringrequired- The identifier of the Statuspage page the component belongs to.
endstring- The 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_eventsboolean- If true, skips supplying the related events data along with the component uptime data.
startstring- The 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_listRetrieve the list of components (services/parts of your infrastructure) configured on a Statuspage page, including their name, status, group, and description.Read-onlyList Components
Retrieve the list of components (services/parts of your infrastructure) configured on a Statuspage page, including their name, status, group, and description. Supports pagination.
Inputs
page_idstringrequired- The identifier of the Statuspage page whose components should be listed
pageinteger- Page offset to fetch, for paginating through results. Starts at 1.
per_pageinteger- Number of results to return per page. Maximum and default limit is 100.
statuspage_incident_getRetrieve details of a single incident on a Statuspage page by its incident ID, including status, impact, affected components, incident updates, and postmortem information.Read-onlyGet Incident
Retrieve details of a single incident on a Statuspage page by its incident ID, including status, impact, affected components, incident updates, and postmortem information.
Inputs
incident_idstringrequired- The identifier of the incident to retrieve
page_idstringrequired- The identifier of the Statuspage page the incident belongs to
statuspage_incident_postmortem_getRetrieve the postmortem for a Statuspage incident, including its draft/published body content and publish status.Read-onlyGet Incident Postmortem
Retrieve the postmortem for a Statuspage incident, including its draft/published body content and publish status.
Inputs
incident_idstringrequired- The identifier of the incident whose postmortem should be retrieved
page_idstringrequired- The identifier of the Statuspage page that owns the incident
statuspage_incident_subscriber_getRetrieve details of a single subscriber to a specific Statuspage incident by subscriber ID.Read-onlyGet Incident Subscriber
Retrieve details of a single subscriber to a specific Statuspage incident by subscriber ID.
Inputs
incident_idstringrequired- The identifier of the incident that the subscriber is subscribed to.
page_idstringrequired- The identifier of the Statuspage page that owns the incident.
subscriber_idstringrequired- The identifier of the incident subscriber to retrieve.
statuspage_incident_subscribers_listGet a list of subscribers who are subscribed to a specific Statuspage incident.Read-onlyList Incident Subscribers
Get a list of subscribers who are subscribed to a specific Statuspage incident. Supports pagination via page and per_page query parameters.
Inputs
incident_idstringrequired- The identifier of the incident whose subscribers should be listed.
page_idstringrequired- The identifier of the Statuspage page that owns the incident.
pageinteger- The page number of results to fetch, starting at 1. Used for pagination.
per_pageinteger- The number of results to return per page.
statuspage_incidents_listRetrieve the list of incidents (including scheduled maintenances) for a Statuspage page.Read-onlyList Incidents
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.
Inputs
page_idstringrequired- The identifier of the Statuspage page whose incidents should be listed
limitinteger- The maximum number of rows to return per page. The default and maximum limit is 100.
pageinteger- Page offset to fetch, for paginating through results. Starts at 1.
qstring- Search for this text query string in the incidents' name, status, postmortem_body, and incident_updates fields.
statuspage_incidents_list_active_maintenanceRetrieve the list of active (in-progress) scheduled maintenances for a Statuspage status page, with optional pagination controls.Read-onlyList Active Maintenances
Retrieve the list of active (in-progress) scheduled maintenances for a Statuspage status page, with optional pagination controls.
Inputs
page_idstringrequired- The identifier of the Statuspage page whose active maintenances should be listed
pagenumber- Page offset to fetch.default
1 per_pagenumber- Number of results to return per page.default
100
statuspage_incidents_list_scheduledGet a list of scheduled maintenance incidents for a Statuspage status page.Read-onlyList Scheduled Incidents
Get a list of scheduled maintenance incidents for a Statuspage status page. Supports pagination via page and per_page query parameters.
Inputs
page_idstringrequired- The identifier of the Statuspage page whose scheduled incidents should be listed.
pageinteger- The page number of results to fetch, starting at 1. Used for pagination.default
1 per_pageinteger- The number of results to return per page. Defaults to 100.default
100
statuspage_incidents_list_unresolvedRetrieve the list of unresolved incidents (incidents that have not yet reached the resolved or completed state) for a Statuspage page.Read-onlyList Unresolved Incidents
Retrieve the list of unresolved incidents (incidents that have not yet reached the resolved or completed state) for a Statuspage page. Supports pagination.
Inputs
page_idstringrequired- The identifier of the Statuspage page whose unresolved incidents should be listed
pageinteger- Page offset to fetch, for paginating through results. Defaults to 1.default
1 per_pageinteger- Number of results to return per page. Defaults to 100.default
100
statuspage_incidents_list_upcomingGet a list of upcoming (future scheduled maintenance) incidents for a Statuspage status page.Read-onlyList Upcoming Incidents
Get a list of upcoming (future scheduled maintenance) incidents for a Statuspage status page. Supports pagination via page and per_page query parameters.
Inputs
page_idstringrequired- The identifier of the Statuspage page whose upcoming incidents should be listed.
pageinteger- The page number of results to fetch, starting at 1. Used for pagination.default
1 per_pageinteger- The number of results to return per page. Defaults to 100.default
100
statuspage_metric_getRetrieve details of a single metric on a Statuspage status page by its metric ID, including its display name, data source, and configuration.Read-onlyGet Metric
Retrieve details of a single metric on a Statuspage status page by its metric ID, including its display name, data source, and configuration.
Inputs
metric_idstringrequired- The identifier of the metric to retrieve
page_idstringrequired- The identifier of the Statuspage page the metric belongs to
statuspage_metric_provider_getGet details of a specific metric provider configured on a Statuspage status page, including its type, base URI, and revalidation timestamps.Read-onlyGet Metric Provider
Get details of a specific metric provider configured on a Statuspage status page, including its type, base URI, and revalidation timestamps.
Inputs
metrics_provider_idstringrequired- The identifier of the metric provider to retrieve.
page_idstringrequired- The identifier of the Statuspage page the metric provider belongs to.
statuspage_metric_provider_metrics_listList the metrics associated with a specific metric provider on a Statuspage status page, with optional pagination controls.Read-onlyList Metric Provider Metrics
List the metrics associated with a specific metric provider on a Statuspage status page, with optional pagination controls.
Inputs
metrics_provider_idstringrequired- The identifier of the metric provider whose metrics should be listed
page_idstringrequired- The identifier of the Statuspage page that owns the metric provider
pagenumber- Page offset to fetch. Beginning February 28, 2023, this endpoint will return paginated data even if this query parameter is not provided.
per_pagenumber- Number of results to return per page. Beginning February 28, 2023, a default and maximum limit of 100 will be imposed.
statuspage_metric_providers_listGet a list of all metric providers configured on a Statuspage status page.Read-onlyList Metric Providers
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.
Inputs
page_idstringrequired- The identifier of the Statuspage page to list metric providers for.
statuspage_metrics_listRetrieve a list of metrics configured on a Statuspage status page, with optional pagination.Read-onlyList Metrics
Retrieve a list of metrics configured on a Statuspage status page, with optional pagination.
Inputs
page_idstringrequired- The identifier of the Statuspage page whose metrics should be listed
pagenumber- The page offset of metrics to fetch. The first page is 0, the second is 1, etc.
per_pagenumber- The number of results to return per page. Maximum and default of 100.
statuspage_page_access_group_components_listRetrieve the list of components a page access group has visibility into on a Statuspage status page.Read-onlyList Page Access Group Components
Retrieve the list of components a page access group has visibility into on a Statuspage status page.
Inputs
page_access_group_idstringrequired- The identifier of the page access group to list components for.
page_idstringrequired- The identifier of the Statuspage page the access group belongs to.
statuspage_page_access_group_getRetrieve details of a single page access group on a Statuspage status page, including its name, associated components, metrics, and page access users.Read-onlyGet Page Access Group
Retrieve details of a single page access group on a Statuspage status page, including its name, associated components, metrics, and page access users.
Inputs
page_access_group_idstringrequired- The identifier of the page access group to retrieve.
page_idstringrequired- The identifier of the Statuspage page the access group belongs to.
statuspage_page_access_groups_listRetrieve a paginated list of page access groups configured for a Statuspage status page.Read-onlyList Page Access Groups
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.
Inputs
page_idstringrequired- The identifier of the Statuspage page to list page access groups for.
pageinteger- Page offset to fetch. As of February 28, 2023, this endpoint returns paginated data even if this parameter is not provided.
per_pageinteger- Number of results to return per page. As of February 28, 2023, a default and maximum limit of 100 is imposed.
statuspage_page_access_user_components_listRetrieve the list of components that a page access user has access to on a Statuspage status page.Read-onlyGet Page Access User Components
Retrieve the list of components that a page access user has access to on a Statuspage status page.
Inputs
page_access_user_idstringrequired- The identifier of the page access user to fetch components for
page_idstringrequired- The identifier of the Statuspage page the access user belongs to
pageinteger- Page offset to fetch
per_pageinteger- Number of results to return per page
statuspage_page_access_user_getRetrieve details of a specific page access user on a Statuspage page, including their email, external login, and associated page access group IDs.Read-onlyGet Page Access User
Retrieve details of a specific page access user on a Statuspage page, including their email, external login, and associated page access group IDs.
Inputs
page_access_user_idstringrequired- The identifier of the page access user to retrieve
page_idstringrequired- The identifier of the Statuspage page that the page access user belongs to
statuspage_page_access_user_metrics_listRetrieve the list of metrics that a page access user has access to on a Statuspage status page.Read-onlyGet Page Access User Metrics
Retrieve the list of metrics that a page access user has access to on a Statuspage status page.
Inputs
page_access_user_idstringrequired- The identifier of the page access user to fetch metrics for
page_idstringrequired- The identifier of the Statuspage page the access user belongs to
pageinteger- Page offset to fetch
per_pageinteger- Number of results to return per page
statuspage_page_access_users_listRetrieve a paginated list of page access users for a Statuspage page.Read-onlyList Page Access Users
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.
Inputs
page_idstringrequired- The identifier of the Statuspage page to list page access users for
emailstring- Email address to search for among page access users
pageinteger- Page offset to fetch for pagination
per_pageinteger- Number of results to return per page. As of February 28, 2023, the API imposes a default and maximum of 100
statuspage_page_getRetrieve details of a Statuspage status page by its page ID, including name, domain, subdomain, URL, branding, and subscriber notification settings.Read-onlyGet Page
Retrieve details of a Statuspage status page by its page ID, including name, domain, subdomain, URL, branding, and subscriber notification settings.
Inputs
page_idstringrequired- The identifier of the Statuspage page to retrieve
statuspage_pages_listGet the list of Statuspage pages accessible to the authenticated API key.Read-onlyList Pages
Get the list of Statuspage pages accessible to the authenticated API key. Use this to discover page_id values before calling the other page-scoped Statuspage tools.
Inputs
This tool takes no inputs.
statuspage_status_embed_config_getRetrieve the status embed config settings for a Statuspage status page, including the iframe position and its background/text colors for incident and maintenance states.Read-onlyGet Status Embed Config
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.
Inputs
page_idstringrequired- The identifier of the Statuspage page whose status embed config should be retrieved
statuspage_subscriber_getRetrieve details of a single subscriber on a Statuspage status page by its subscriber ID, including contact information, type, and state.Read-onlyGet Subscriber
Retrieve details of a single subscriber on a Statuspage status page by its subscriber ID, including contact information, type, and state.
Inputs
page_idstringrequired- The identifier of the Statuspage page the subscriber belongs to
subscriber_idstringrequired- The identifier of the subscriber to retrieve
statuspage_subscribers_count_getRetrieve a count of subscribers on a Statuspage status page, optionally filtered by subscriber type and state.Read-onlyGet Subscriber Count
Retrieve a count of subscribers on a Statuspage status page, optionally filtered by subscriber type and state.
Inputs
page_idstringrequired- The identifier of the Statuspage page to count subscribers for
statestring- If present, only count subscribers in this state. Specify "all" to count subscribers in any state.one of
activeunconfirmedquarantinedalldefaultactive typestring- If present, only count subscribers of this typeone of
emailsmsslackwebhookteamsintegration_partner
statuspage_subscribers_histogram_by_state_getRetrieve a histogram of subscribers on a Statuspage status page, broken down by subscriber type and then by state (active, unconfirmed, quarantined).Read-onlyGet Subscribers Histogram by State
Retrieve a histogram of subscribers on a Statuspage status page, broken down by subscriber type and then by state (active, unconfirmed, quarantined).
Inputs
page_idstringrequired- The identifier of the Statuspage page to retrieve the subscriber histogram for
statuspage_subscribers_listRetrieve 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.Read-onlyList Subscribers
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.
Inputs
page_idstringrequired- The identifier of the Statuspage page whose subscribers should be listed
limitnumber- The maximum number of subscribers to return. If a search query (q) is specified, the default and maximum limit is 100.
pagenumber- The zero-based page offset of subscribers to fetch. The first page is 0, the second is 1, etc.default
0 qstring- Search text to match against subscriber contact information (email, endpoint, or phone number). Not supported for Slack subscribers.
sort_directionstring- The sort direction of the listing: asc or desc.one of
ascdescdefaultasc sort_fieldstring- The 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).one of
primarycreated_atquarantined_atrelevancedefaultprimary statestring- Filter to only return subscribers in this state. Use 'all' to return subscribers in any state. Defaults to active.one of
activeunconfirmedquarantinedalldefaultactive typestring- Filter to only return subscribers of this type. One of email, sms, webhook, slack, teams, integration_partner.one of
emailsmswebhookslackteamsintegration_partner
statuspage_subscribers_list_unsubscribedRetrieve a paginated list of unsubscribed subscribers for a Statuspage status page.Read-onlyList Unsubscribed Subscribers
Retrieve a paginated list of unsubscribed subscribers for a Statuspage status page.
Inputs
page_idstringrequired- The identifier of the Statuspage page to list unsubscribed subscribers for
pagenumber- Page offset to fetch
per_pagenumber- Number of results to return per page
statuspage_templates_listRetrieve the list of incident templates configured on a Statuspage status page, with optional pagination controls.Read-onlyList Templates
Retrieve the list of incident templates configured on a Statuspage status page, with optional pagination controls.
Inputs
page_idstringrequired- The identifier of the Statuspage page whose templates should be listed
pagenumber- Page offset to fetch.default
1 per_pagenumber- Number of results to return per page.default
100
statuspage_user_permissions_getRetrieve 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.Read-onlyGet User Permissions
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.
Inputs
organization_idstringrequired- The identifier of the Statuspage organization that the user belongs to
user_idstringrequired- The identifier of the user whose permissions should be retrieved
statuspage_users_listRetrieve a list of team members (users) belonging to a Statuspage organization, with optional pagination.Read-onlyList Users
Retrieve a list of team members (users) belonging to a Statuspage organization, with optional pagination.
Inputs
organization_idstringrequired- The identifier of the Statuspage organization whose users should be listed
pagenumber- The page offset of users to fetch. The first page is 0, the second is 1, etc.
per_pagenumber- The number of results to return per page. Maximum and default of 100.
statuspage_component_createCreate a new component (a service or part of your infrastructure) on a Statuspage page, with a display name, status, description, and optional group assignment.WriteCreate Component
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.
Inputs
namestringrequired- Display name for the component, e.g. 'API' or 'Website'.
page_idstringrequired- The identifier of the Statuspage page to create the component on
descriptionstring- More detailed description for the component.
group_idstring- Identifier of the component group to add this component to.
only_show_if_degradedboolean- Whether to only show this component if it is degraded. Requires a special feature flag to be enabled on your account.
showcaseboolean- Whether this component should be showcased on the status page.
start_datestring- The date this component started being used, in YYYY-MM-DD format.
statusstring- Status of the component. Valid values: operational, under_maintenance, degraded_performance, partial_outage, major_outage.one of
operationalunder_maintenancedegraded_performancepartial_outagemajor_outage
statuspage_component_group_createCreate a new component group on a Statuspage status page.WriteCreate Component Group
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.
Inputs
componentsarrayrequired- Array of component IDs to include in this group.
namestringrequired- Name of the component group as it will appear on the status page.
page_idstringrequired- The identifier of the Statuspage page to create the component group on.
descriptionstring- Description of the component group, shown to visitors of the status page.
statuspage_component_group_updateUpdate an existing component group on a Statuspage status page.WriteUpdate Component Group
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.
- Idempotent
Inputs
idstringrequired- The identifier of the component group to update.
page_idstringrequired- The identifier of the Statuspage page the component group belongs to.
componentsarray- Updated array of component IDs to include in this group. Replaces the existing set of components.
descriptionstring- Updated description of the component group, shown to visitors of the status page.
namestring- Updated name of the component group.
statuspage_component_page_access_groups_addGrant a list of page access groups access to a specific component on a Statuspage status page.WriteAdd Component Page Access Groups
Grant a list of page access groups access to a specific component on a Statuspage status page.
Inputs
component_idstringrequired- The identifier of the component to grant page access groups access to.
page_access_group_idsarrayrequired- List of page access group IDs to grant access to this component.
page_idstringrequired- The identifier of the Statuspage page that owns the component.
statuspage_component_page_access_users_addGrant a list of page access users direct access to a specific component on a Statuspage status page.WriteAdd Component Page Access Users
Grant a list of page access users direct access to a specific component on a Statuspage status page.
Inputs
component_idstringrequired- The identifier of the component to grant page access users access to.
page_access_user_idsarrayrequired- List of page access user IDs to grant access to this component.
page_idstringrequired- The identifier of the Statuspage page that owns the component.
statuspage_component_updateUpdate a component on a Statuspage page, such as its name, status, description, or group assignment.WriteUpdate Component
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.
- Idempotent
Inputs
component_idstringrequired- The identifier of the component to update
page_idstringrequired- The identifier of the Statuspage page the component belongs to
descriptionstring- More detailed description for the component.
group_idstring- Identifier of the component group to assign this component to. Set to an empty string or null to remove the component from its group.
namestring- Display name for the component.
only_show_if_degradedboolean- Whether to only show this component if it is degraded. Requires a special feature flag to be enabled on your account.
showcaseboolean- Whether this component should be showcased on the status page.
start_datestring- The date this component started being used, in YYYY-MM-DD format.
statusstring- Status of the component. Valid values: operational, under_maintenance, degraded_performance, partial_outage, major_outage.one of
operationalunder_maintenancedegraded_performancepartial_outagemajor_outage
statuspage_incident_createCreate a new incident or scheduled maintenance on a Statuspage page.WriteCreate Incident
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.
Inputs
namestringrequired- Incident name. Maximum length of 255 characters.
page_idstringrequired- The identifier of the Statuspage page to create the incident on
auto_transition_deliver_notifications_at_endboolean- Whether to send a notification when the scheduled maintenance automatically transitions to completed.
auto_transition_deliver_notifications_at_startboolean- Whether to send a notification when the scheduled maintenance automatically transitions to started.
auto_transition_to_maintenance_stateboolean- Whether to change affected components' status to under_maintenance once the scheduled maintenance is in progress.
auto_transition_to_operational_stateboolean- Whether to change affected components' status to operational once the scheduled maintenance completes.
auto_tweet_at_beginningboolean- Whether to tweet automatically when the scheduled maintenance starts.
auto_tweet_on_completionboolean- Whether to tweet automatically when the scheduled maintenance completes.
auto_tweet_on_creationboolean- Whether to tweet automatically when the scheduled maintenance is created.
auto_tweet_one_hour_beforeboolean- Whether to tweet automatically one hour before the scheduled maintenance starts.
backfill_datestring- Timestamp for when the incident was backfilled, in YYYY-MM-DD format.
backfilledboolean- Whether the incident is backfilled (recorded after the fact). If true, components cannot be specified.
bodystring- The initial message, created as the first incident update. Maximum length of 25000 characters.
component_idsarray- List of component IDs affected by this incident. Example: ["kctbh9vrtdwd", "lcy4z7wq3fjr"].
componentsobject- Map 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_notificationsboolean- Whether to deliver notifications to subscribers. If false, the incident is created without notifying customers. Defaults to true.
impact_overridestring- Value to override the calculated impact value. Valid values: none, maintenance, minor, major, critical.one of
nonemaintenanceminormajorcritical metadataobject- Arbitrary 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_intervalsstring- Custom 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_completedboolean- Whether the incident is scheduled to automatically transition to completed at its scheduled end time.
scheduled_auto_in_progressboolean- Whether the incident is scheduled to automatically transition to in_progress at its scheduled start time.
scheduled_forstring- The ISO 8601 timestamp the scheduled incident is scheduled to start.
scheduled_remind_priorboolean- Whether to remind subscribers prior to the scheduled incident starting.
scheduled_untilstring- The ISO 8601 timestamp the scheduled incident is scheduled to end.
statusstring- The 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.one of
investigatingidentifiedmonitoringresolvedscheduledin_progressverifyingcompleted
statuspage_incident_postmortem_createCreate (or replace) the draft postmortem body for a Statuspage incident.WriteCreate Incident Postmortem
Create (or replace) the draft postmortem body for a Statuspage incident.
- Idempotent
Inputs
body_draftstringrequired- Body of Postmortem to create.
incident_idstringrequired- The identifier of the incident to create a postmortem for
page_idstringrequired- The identifier of the Statuspage page that owns the incident
statuspage_incident_postmortem_publishPublish the postmortem report for a Statuspage incident, making it visible on the public status page.WritePublish Postmortem
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.
- Idempotent
Inputs
incident_idstringrequired- The identifier of the incident whose postmortem should be published.
page_idstringrequired- The identifier of the Statuspage page that owns the incident.
custom_tweetstring- Custom postmortem tweet text to publish when notify_twitter is true. If omitted, a default tweet is used.
notify_subscribersboolean- Whether to notify e-mail subscribers that the postmortem has been published. Defaults to the page's configured behavior if omitted.
notify_twitterboolean- Whether to notify Twitter followers that the postmortem has been published. Defaults to the page's configured behavior if omitted.
statuspage_incident_postmortem_revertRevert a published postmortem report for a Statuspage incident back to draft, unpublishing it from the public status page.WriteRevert Postmortem
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.
- Idempotent
Inputs
incident_idstringrequired- The identifier of the incident whose postmortem should be reverted to draft.
page_idstringrequired- The identifier of the Statuspage page that owns the incident.
statuspage_incident_subscriber_createCreate a new subscriber (email or SMS) for notifications about a specific Statuspage incident.WriteCreate Incident Subscriber
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.
Inputs
incident_idstringrequired- The identifier of the incident to subscribe to.
page_idstringrequired- The identifier of the Statuspage page that owns the incident.
emailstring- The email address to use for creating an email subscriber. Required if phone_number is not provided.
phone_countrystring- The two-character country code (e.g. 'US') for the phone number location, used when creating an SMS subscriber.
phone_numberstring- The phone number (as dialed from phone_country) to use for creating an SMS subscriber. Required if email is not provided.
skip_confirmation_notificationboolean- If 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_resend_confirmationResend the confirmation notification (email or SMS) to a pending subscriber of a specific Statuspage incident.WriteResend Incident Subscriber 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.
Inputs
incident_idstringrequired- The identifier of the incident the subscriber is subscribed to.
page_idstringrequired- The identifier of the Statuspage page that owns the incident.
subscriber_idstringrequired- The identifier of the incident subscriber to resend a confirmation notification to.
statuspage_incident_updateUpdate 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.WriteUpdate Incident
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.
- Idempotent
Inputs
incident_idstringrequired- The identifier of the incident to update
page_idstringrequired- The identifier of the Statuspage page the incident belongs to
auto_transition_deliver_notifications_at_endboolean- Whether to send a notification when the scheduled maintenance automatically transitions to completed.
auto_transition_deliver_notifications_at_startboolean- Whether to send a notification when the scheduled maintenance automatically transitions to started.
auto_transition_to_maintenance_stateboolean- Whether to change affected components' status to under_maintenance once the scheduled maintenance is in progress.
auto_transition_to_operational_stateboolean- Whether to change affected components' status to operational once the scheduled maintenance completes.
auto_tweet_at_beginningboolean- Whether to tweet automatically when the scheduled maintenance starts.
auto_tweet_on_completionboolean- Whether to tweet automatically when the scheduled maintenance completes.
auto_tweet_on_creationboolean- Whether to tweet automatically when the scheduled maintenance is created.
auto_tweet_one_hour_beforeboolean- Whether to tweet automatically one hour before the scheduled maintenance starts.
backfill_datestring- Timestamp for when the incident was backfilled, in YYYY-MM-DD format.
backfilledboolean- Whether the incident is backfilled (recorded after the fact). If true, components cannot be specified.
bodystring- The initial message, created as the first incident update. Maximum length of 25000 characters.
component_idsarray- List of component IDs affected by this incident. Example: ["kctbh9vrtdwd", "lcy4z7wq3fjr"].
componentsobject- Map 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_notificationsboolean- Whether to deliver notifications to subscribers. If false, the incident is created without notifying customers. Defaults to true.
impact_overridestring- Value to override the calculated impact value. Valid values: none, maintenance, minor, major, critical.one of
nonemaintenanceminormajorcritical metadataobject- Arbitrary JSON object attached to the incident. All top-level values in the object must also be objects, e.g. {"jira": {"issue_id": "ABC-123"}}.
namestring- Incident name. Maximum length of 255 characters.
reminder_intervalsstring- Custom 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_completedboolean- Whether the incident is scheduled to automatically transition to completed at its scheduled end time.
scheduled_auto_in_progressboolean- Whether the incident is scheduled to automatically transition to in_progress at its scheduled start time.
scheduled_auto_transitionboolean- Same as scheduled_auto_in_progress. Controls whether the incident is scheduled to automatically change to in_progress.
scheduled_forstring- The ISO 8601 timestamp the scheduled incident is scheduled to start.
scheduled_remind_priorboolean- Whether to remind subscribers prior to the scheduled incident starting.
scheduled_untilstring- The ISO 8601 timestamp the scheduled incident is scheduled to end.
statusstring- The 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.one of
investigatingidentifiedmonitoringresolvedscheduledin_progressverifyingcompleted
statuspage_incident_update_editUpdate a previous incident update on a Statuspage status page, editing its body text, display timestamp, or the Twitter/notification delivery flags.WriteEdit Incident Update
Update a previous incident update on a Statuspage status page, editing its body text, display timestamp, or the Twitter/notification delivery flags.
- Idempotent
Inputs
incident_idstringrequired- The identifier of the incident that owns the incident update
incident_update_idstringrequired- The identifier of the incident update to edit
page_idstringrequired- The identifier of the Statuspage page that owns the incident
bodystring- Incident update body.
deliver_notificationsboolean- Controls whether to delivery notifications.
display_atstring- Timestamp when incident update is happened.
wants_twitter_updateboolean- Controls whether to create twitter update.
statuspage_metric_data_addAdd a single data point to a metric on a Statuspage status page.WriteAdd Metric Data
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.
Inputs
metric_idstringrequired- The identifier of the metric to add data to.
page_idstringrequired- The identifier of the Statuspage page the metric belongs to.
timestampintegerrequired- Unix timestamp (seconds since epoch) to store the data point against.
valuenumberrequired- Numeric value of the data point to record.
statuspage_metric_provider_createCreate 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.WriteCreate Metric Provider
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.
Inputs
page_idstringrequired- The identifier of the Statuspage page to create the metric provider on.
typestringrequired- The type of metrics provider to create. One of Pingdom, NewRelic, Librato, Datadog, or Self.one of
PingdomNewRelicLibratoDatadogSelf api_keystring- API key credential. Required by the Datadog and NewRelic type metrics providers.
api_tokenstring- API token credential. Required by the Librato, Datadog, and Pingdom type metrics providers.
application_keystring- Application key credential. Required by the Pingdom-type metrics provider.
emailstring- Account email address. Required by the Librato metrics provider.
metric_base_uristring- Base URI for the metrics provider's API. Required by the Datadog and NewRelic type metrics providers.
passwordstring- Account password for the metrics provider, if required by that provider type.
statuspage_metric_provider_metric_createCreate a new metric for a metric provider on a Statuspage page.WriteCreate Metric For Metric Provider
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.
Inputs
metrics_provider_idstringrequired- The identifier of the metric provider under which to create the metric
namestringrequired- Name of the metric to display on the graph
page_idstringrequired- The identifier of the Statuspage page that owns the metric provider
application_idstring- The identifier for the New Relic application. Required only when the metric provider type is NewRelic
decimal_placesinteger- How many decimal places to render on the graph
displayboolean- Whether the metric should be displayed on the status page
metric_identifierstring- The identifier used to look up the metric data from the provider (provider-specific, e.g. a Pingdom check ID or NewRelic metric name)
suffixstring- Suffix to describe the units on the graph, e.g. ms, %, req/s
tooltip_descriptionstring- Description text shown in the graph tooltip
transformstring- The transform to apply to the metric before pulling it into Statuspage. One of: average, count, max, min, or sumone of
averagecountmaxminsum y_axis_hiddenboolean- Whether the values on the y axis should be hidden when rendering the graph
y_axis_maxinteger- The upper bound of the y axis on the graph
y_axis_mininteger- The lower bound of the y axis on the graph
statuspage_metric_provider_updateUpdate an existing metric provider (e.g.WriteUpdate Metric Provider
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.
- Idempotent
Inputs
metrics_provider_idstringrequired- The identifier of the metric provider to update
page_idstringrequired- The identifier of the Statuspage page that owns the metric provider
metric_base_uristring- The base URI used to query metric data from the provider, if applicable
typestring- The type of the metrics provider integration, e.g. Pingdom, NewRelic, Librato, Datadog, Statuspage, Custom, Self
statuspage_metric_updateUpdate an existing metric on a Statuspage status page.WriteUpdate Metric
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.
- Idempotent
Inputs
metric_idstringrequired- The identifier of the metric to update.
page_idstringrequired- The identifier of the Statuspage page the metric belongs to.
metric_identifierstring- Updated metric display identifier used to look up the metric data from the provider.
namestring- Updated display name of the metric.
statuspage_metrics_data_add_batchAdd data points to one or more metrics on a Statuspage status page in a single request.WriteAdd Metrics Data (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.
Inputs
dataobjectrequired- Object mapping metric IDs to arrays of data points, each with a unix timestamp and numeric value. Example: {"vq23nrtrsy1j": [{"timestamp": 1783078513, "value": 123.456}]}
page_idstringrequired- The identifier of the Statuspage page the metrics belong to.
statuspage_page_access_group_components_addAdd one or more components to a page access group's visibility on a Statuspage status page.WriteAdd Page Access Group Components
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.
Inputs
component_idsarrayrequired- List of component IDs to add to this page access group's visibility.
page_access_group_idstringrequired- The identifier of the page access group to add components to.
page_idstringrequired- The identifier of the Statuspage page the access group belongs to.
statuspage_page_access_group_createCreate a new page access group on a Statuspage status page.WriteCreate Page Access Group
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.
Inputs
page_idstringrequired- The identifier of the Statuspage page to create the access group on.
component_idsarray- List of component IDs this page access group should have visibility into.
external_identifierstring- Associates the group with an external group, such as an SSO/IdP group identifier.
metric_idsarray- List of metric IDs this page access group should have visibility into.
namestring- Name for this page access group.
page_access_user_idsarray- List of page access user IDs to add to this group.
statuspage_page_access_group_updateUpdate 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.WriteUpdate Page Access Group
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.
- Idempotent
Inputs
page_access_group_idstringrequired- The identifier of the page access group to update.
page_idstringrequired- The identifier of the Statuspage page the access group belongs to.
component_idsarray- List of component IDs this page access group should have visibility into. Replaces the existing set.
external_identifierstring- Associates the group with an external group, such as an SSO/IdP group identifier.
metric_idsarray- List of metric IDs this page access group should have visibility into. Replaces the existing set.
namestring- Name for this page access group.
page_access_user_idsarray- List of page access user IDs in this group. Replaces the existing set.
statuspage_page_access_user_components_addGrant a page access user access to additional components on a Statuspage status page, without affecting components they already have access to.WriteAdd Page Access User Components
Grant a page access user access to additional components on a Statuspage status page, without affecting components they already have access to.
Inputs
component_idsarrayrequired- List of component codes to grant access to, in addition to existing access
page_access_user_idstringrequired- The identifier of the page access user to grant component access to
page_idstringrequired- The identifier of the Statuspage page the access user belongs to
statuspage_page_access_user_components_replaceReplace the full set of components a page access user has access to on a Statuspage status page.WriteReplace Page Access User Components
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.
- Idempotent
Inputs
component_idsarrayrequired- List of component codes the user should have exclusive access to
page_access_user_idstringrequired- The identifier of the page access user whose component access will be replaced
page_idstringrequired- The identifier of the Statuspage page the access user belongs to
statuspage_page_access_user_createAdd a page access user to a Statuspage status page, optionally granting access to specific page access groups and subscribing them to components.WriteAdd Page Access User
Add a page access user to a Statuspage status page, optionally granting access to specific page access groups and subscribing them to components.
Inputs
page_idstringrequired- The identifier of the Statuspage page to add the access user to
emailstring- Email address of the page access user
external_loginstring- IDP login user id for the page access user
page_access_group_idsarray- List of page access group ids to associate with this user
subscribe_to_componentsboolean- Whether to subscribe this user to component notifications
statuspage_page_access_user_metrics_addGrant a page access user access to additional metrics on a Statuspage status page, without affecting metrics they already have access to.WriteAdd Page Access User Metrics
Grant a page access user access to additional metrics on a Statuspage status page, without affecting metrics they already have access to.
Inputs
metric_idsarrayrequired- List of metric ids to grant access to, in addition to existing access
page_access_user_idstringrequired- The identifier of the page access user to grant metric access to
page_idstringrequired- The identifier of the Statuspage page the access user belongs to
statuspage_page_access_user_metrics_replaceReplace the full set of metrics visible to a page access user on a Statuspage status page.WriteReplace Page Access User Metrics
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.
- Idempotent
Inputs
metric_idsarrayrequired- The full list of metric IDs this page access user should have access to. Replaces any existing metric assignments.
page_access_user_idstringrequired- The identifier of the page access user whose metrics will be replaced.
page_idstringrequired- The identifier of the Statuspage page the access user belongs to.
statuspage_page_access_user_updateUpdate an existing page access user on a Statuspage status page, including their external login, email, or page access group memberships.WriteUpdate Page Access User
Update an existing page access user on a Statuspage status page, including their external login, email, or page access group memberships.
- Idempotent
Inputs
page_access_user_idstringrequired- The identifier of the page access user to update
page_idstringrequired- The identifier of the Statuspage page the access user belongs to
emailstring- Email address of the page access user
external_loginstring- IDP login user id for the page access user
page_access_group_idsarray- List of page access group ids to associate with this user
statuspage_page_updateUpdate settings for a Statuspage status page, including name, domain, subdomain, URL, branding template, CSS theme colors, subscriber notification options, and time zone.WriteUpdate Page
Update settings for a Statuspage status page, including name, domain, subdomain, URL, branding template, CSS theme colors, subscriber notification options, and time zone.
- Idempotent
Inputs
page_idstringrequired- The identifier of the Statuspage page to update
allow_email_subscribersboolean- Whether your users can choose to receive notifications via email.
allow_incident_subscribersboolean- Whether your users can subscribe to notifications for a single incident.
allow_page_subscribersboolean- Whether your users can subscribe to all notifications on the page.
allow_rss_atom_feedsboolean- Whether your users can access incident feeds via RSS/Atom. Not functional on Audience-Specific pages.
allow_sms_subscribersboolean- Whether your users can choose to receive notifications via SMS.
allow_webhook_subscribersboolean- Whether your users can choose to receive notifications via webhooks.
brandingstring- The main template your statuspage will use. Valid values are basic and premium.one of
basicpremium css_bluesstring- CSS color used for informational elements.
css_body_background_colorstring- CSS color for the page body background, e.g. a hex value like #fff.
css_border_colorstring- CSS color used for borders throughout the page.
css_font_colorstring- CSS color for the primary font color, e.g. a hex value like #333.
css_graph_colorstring- CSS color used for uptime graphs.
css_greensstring- CSS color used to represent operational/healthy status.
css_light_font_colorstring- CSS color for the light/secondary font color.
css_link_colorstring- CSS color used for hyperlinks on the page.
css_no_datastring- CSS color used when there is no uptime data available.
css_orangesstring- CSS color used to represent partial outage status.
css_redsstring- CSS color used to represent major outage status.
css_yellowsstring- CSS color used to represent degraded performance status.
domainstring- CNAME alias for your status page
hidden_from_searchboolean- Whether your page should hide itself from search engines.
namestring- Name of your page to be displayed
notifications_email_footerstring- Customize the footer appearing on your notification emails. Accepts Markdown for formatting.
notifications_from_emailstring- Customize the email address your page notifications come from.
subdomainstring- Subdomain at which to access your status page
time_zonestring- Timezone configured for your page.
urlstring- Website of your page. Clicking on your statuspage image will link here.
viewers_must_be_team_membersboolean- Whether only team members can view the page.
statuspage_status_embed_config_updateUpdate the status embed config settings for a Statuspage status page, including the iframe corner position and background/text colors for incident and maintenance states.WriteUpdate Status Embed Config
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.
- Idempotent
Inputs
page_idstringrequired- The identifier of the Statuspage page whose status embed config should be updated
incident_background_colorstring- Color of status embed iframe background when displaying incident
incident_text_colorstring- Color of status embed iframe text when displaying incident
maintenance_background_colorstring- Color of status embed iframe background when displaying maintenance
maintenance_text_colorstring- Color of status embed iframe text when displaying maintenance
positionstring- Corner where status embed iframe will appear on page
statuspage_subscriber_createCreate a new subscriber on a Statuspage status page.WriteCreate Subscriber
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.
Inputs
page_idstringrequired- The identifier of the Statuspage page to add the subscriber to
component_idsarray- A 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.
emailstring- The email address for creating an Email subscriber, or the contact email for a Webhook subscriber. Required for email-type subscribers.
endpointstring- The endpoint URI for creating a Webhook subscriber. Required when creating a webhook-type subscriber.
page_access_userstring- The code of the page access user to which the subscriber belongs, scoping the subscription to that user's permitted components.
phone_countrystring- The 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_numberstring- The 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_notificationboolean- If 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_resend_confirmationResend the confirmation email or notification to a single unconfirmed subscriber on a Statuspage status page.WriteResend Subscriber Confirmation
Resend the confirmation email or notification to a single unconfirmed subscriber on a Statuspage status page.
Inputs
page_idstringrequired- The identifier of the Statuspage page the subscriber belongs to
subscriber_idstringrequired- The identifier of the subscriber to resend the confirmation to
statuspage_subscriber_updateUpdate a subscriber's component subscriptions on a Statuspage status page.WriteUpdate Subscriber
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.
- Idempotent
Inputs
page_idstringrequired- The identifier of the Statuspage page the subscriber belongs to
subscriber_idstringrequired- The identifier of the subscriber to update
component_idsarray- A 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_reactivate_bulkReactivate a list of quarantined subscribers on a Statuspage status page, optionally filtered by subscriber type, or reactivate all quarantined subscribers.WriteReactivate Subscribers (Bulk)
Reactivate a list of quarantined subscribers on a Statuspage status page, optionally filtered by subscriber type, or reactivate all quarantined subscribers.
- Idempotent
Inputs
page_idstringrequired- The identifier of the Statuspage page the subscribers belong to
subscribersarrayrequired- List of quarantined subscriber codes to reactivate, or a single-element array containing "all" to reactivate all quarantined subscribers
typestring- If present, only reactivate subscribers of this typeone of
emailsmsslackwebhookintegration_partner
statuspage_subscribers_resend_confirmation_bulkResend confirmation notifications to a list of unconfirmed subscribers on a Statuspage status page, or to all unconfirmed email subscribers.WriteResend Confirmation to Subscribers (Bulk)
Resend confirmation notifications to a list of unconfirmed subscribers on a Statuspage status page, or to all unconfirmed email subscribers.
Inputs
page_idstringrequired- The identifier of the Statuspage page the subscribers belong to
subscribersarrayrequired- List of subscriber codes to resend confirmations for, or a single-element array containing "all" to resend to all unconfirmed email subscribers
statuspage_template_createCreate a new incident template on a Statuspage status page.WriteCreate Template
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.
Inputs
bodystringrequired- The initial message, created as the first incident or maintenance update.
namestringrequired- Name of the template, as shown in the list on the "Templates" tab of the "Incidents" page
page_idstringrequired- The identifier of the Statuspage page on which to create the template
titlestringrequired- Title to be applied to the incident or maintenance when selecting this template
component_idsarray- List of component_ids affected by this incident
group_idstring- Identifier of Template Group this template belongs to
should_send_notificationsboolean- Whether the "deliver notifications" checkbox should be selected when selecting this template
should_tweetboolean- Whether the "tweet update" checkbox should be selected when selecting this template
update_statusstring- The status the incident or maintenance should transition to when selecting this templateone of
investigatingidentifiedmonitoringresolvedscheduledin_progressverifyingcompleted
statuspage_user_createCreate a new team member (user) in a Statuspage organization, granting them access to manage the organization's status pages.WriteCreate User
Create a new team member (user) in a Statuspage organization, granting them access to manage the organization's status pages.
Inputs
emailstringrequired- Email address for the new team member. This is the address they will use to sign in.
organization_idstringrequired- The identifier of the Statuspage organization to add the user to
first_namestring- First name of the new team member.
last_namestring- Last name of the new team member.
passwordstring- Password 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_permissions_updateUpdate a Statuspage organization user's role permissions.WriteUpdate User Permissions
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.
- Idempotent
Inputs
organization_idstringrequired- The identifier of the Statuspage organization that the user belongs to
pagesobjectrequired- Mapping 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_idstringrequired- The identifier of the user whose permissions should be updated
statuspage_component_deletePermanently delete a component from a Statuspage status page.DestructiveDelete Component
Permanently delete a component from a Statuspage status page.
- Idempotent
Inputs
component_idstringrequired- The identifier of the component to delete
page_idstringrequired- The identifier of the Statuspage page the component belongs to
statuspage_component_group_deletePermanently delete a component group from a Statuspage status page.DestructiveDelete Component Group
Permanently delete a component group from a Statuspage status page.
- Idempotent
Inputs
idstringrequired- The identifier of the component group to delete
page_idstringrequired- The identifier of the Statuspage page the component group belongs to
statuspage_component_page_access_groups_removeRevoke all page access groups' access from a specific component on a Statuspage status page.DestructiveRemove Component Page Access Groups
Revoke all page access groups' access from a specific component on a Statuspage status page.
- Idempotent
Inputs
component_idstringrequired- The identifier of the component to remove page access groups from.
page_idstringrequired- The identifier of the Statuspage page that owns the component.
statuspage_component_page_access_users_removeRevoke all page access users' direct access from a specific component on a Statuspage status page.DestructiveRemove Component Page Access Users
Revoke all page access users' direct access from a specific component on a Statuspage status page.
- Idempotent
Inputs
component_idstringrequired- The identifier of the component to remove page access users from.
page_idstringrequired- The identifier of the Statuspage page that owns the component.
statuspage_incident_deletePermanently delete an incident from a Statuspage status page.DestructiveDelete Incident
Permanently delete an incident from a Statuspage status page. This action cannot be undone.
- Idempotent
Inputs
incident_idstringrequired- The identifier of the incident to delete
page_idstringrequired- The identifier of the Statuspage page that owns the incident
statuspage_incident_postmortem_deletePermanently delete the postmortem report associated with a Statuspage incident.DestructiveDelete Postmortem
Permanently delete the postmortem report associated with a Statuspage incident. Per the Statuspage API spec, this returns HTTP 204 No Content on success.
- Idempotent
Inputs
incident_idstringrequired- The identifier of the incident whose postmortem should be deleted.
page_idstringrequired- The identifier of the Statuspage page that owns the incident.
statuspage_incident_subscriber_unsubscribeUnsubscribe a subscriber from notifications about a specific Statuspage incident.DestructiveUnsubscribe Incident Subscriber
Unsubscribe a subscriber from notifications about a specific Statuspage incident. Per the Statuspage API spec, this returns HTTP 200 on success.
- Idempotent
Inputs
incident_idstringrequired- The identifier of the incident the subscriber is subscribed to.
page_idstringrequired- The identifier of the Statuspage page that owns the incident.
subscriber_idstringrequired- The identifier of the incident subscriber to unsubscribe.
statuspage_metric_data_resetReset (permanently delete) all historical data points for a metric on a Statuspage page, while keeping the metric configuration itself intact.DestructiveReset Metric Data
Reset (permanently delete) all historical data points for a metric on a Statuspage page, while keeping the metric configuration itself intact.
- Idempotent
Inputs
metric_idstringrequired- The identifier of the metric whose data should be reset
page_idstringrequired- The identifier of the Statuspage page that owns the metric
statuspage_metric_deleteDelete a metric from a Statuspage metric provider.DestructiveDelete Metric
Delete a metric from a Statuspage metric provider. This permanently removes the metric configuration and its associated data from the given page.
- Idempotent
Inputs
metric_idstringrequired- The identifier of the metric to delete
page_idstringrequired- The identifier of the Statuspage page that owns the metric
statuspage_metric_provider_deleteDelete a metric provider from a Statuspage page.DestructiveDelete Metric Provider
Delete a metric provider from a Statuspage page. This permanently removes the provider integration and all metrics associated with it.
- Idempotent
Inputs
metrics_provider_idstringrequired- The identifier of the metric provider to delete
page_idstringrequired- The identifier of the Statuspage page that owns the metric provider
statuspage_page_access_group_component_removeRemove a single component from a page access group on a Statuspage status page, identified by page ID, page access group ID, and component ID.DestructiveRemove Page Access Group Component
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.
- Idempotent
Inputs
component_idstringrequired- The identifier of the component to remove from the page access group.
page_access_group_idstringrequired- The identifier of the page access group to remove the component from.
page_idstringrequired- The identifier of the Statuspage page that owns the page access group.
statuspage_page_access_group_components_deleteDelete a specified list of components from a page access group on a Statuspage status page.DestructiveDelete Page Access Group Components
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.
- Idempotent
Inputs
component_idsarrayrequired- The list of component IDs to remove from the page access group.
page_access_group_idstringrequired- The identifier of the page access group to remove components from.
page_idstringrequired- The identifier of the Statuspage page that owns the page access group.
statuspage_page_access_group_components_replaceReplace the full set of components assigned to a page access group on a Statuspage status page.DestructiveReplace Page Access Group Components
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.
- Idempotent
Inputs
component_idsarrayrequired- The full list of component IDs to set on the page access group. This replaces any previously assigned components.
page_access_group_idstringrequired- The identifier of the page access group whose components should be replaced.
page_idstringrequired- The identifier of the Statuspage page that owns the page access group.
statuspage_page_access_group_deletePermanently remove a page access group from a Statuspage status page.DestructiveRemove Page Access Group
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.
- Idempotent
Inputs
page_access_group_idstringrequired- The identifier of the page access group to remove.
page_idstringrequired- The identifier of the Statuspage page the access group belongs to.
statuspage_page_access_user_component_removeRemove a single component from a page access user's allowed components on a Statuspage status page.DestructiveRemove Component For Page Access User
Remove a single component from a page access user's allowed components on a Statuspage status page.
- Idempotent
Inputs
component_idstringrequired- The identifier of the component to remove access to
page_access_user_idstringrequired- The identifier of the page access user to remove the component from
page_idstringrequired- The identifier of the Statuspage page the access user belongs to
statuspage_page_access_user_components_removeRemove a page access user's access to a specific set of components on a Statuspage status page.DestructiveRemove Page Access User Components
Remove a page access user's access to a specific set of components on a Statuspage status page. Components not listed remain accessible.
- Idempotent
Inputs
component_idsarrayrequired- List of component codes to revoke access to
page_access_user_idstringrequired- The identifier of the page access user to remove component access from
page_idstringrequired- The identifier of the Statuspage page the access user belongs to
statuspage_page_access_user_deletePermanently delete a page access user from a Statuspage status page.DestructiveDelete Page Access User
Permanently delete a page access user from a Statuspage status page. This removes the user's access entirely.
- Idempotent
Inputs
page_access_user_idstringrequired- The identifier of the page access user to delete
page_idstringrequired- The identifier of the Statuspage page the access user belongs to
statuspage_page_access_user_metric_deleteRemove a single metric from a page access user's visibility on a Statuspage status page.DestructiveDelete Page Access User Metric
Remove a single metric from a page access user's visibility on a Statuspage status page.
- Idempotent
Inputs
metric_idstringrequired- The identifier of the metric to remove from this page access user's visibility.
page_access_user_idstringrequired- The identifier of the page access user whose metric will be removed.
page_idstringrequired- The identifier of the Statuspage page the access user belongs to.
statuspage_page_access_user_metrics_deleteRemove one or more metrics from a page access user's visibility on a Statuspage status page.DestructiveDelete Page Access User Metrics
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.
- Idempotent
Inputs
metric_idsarrayrequired- List of metric IDs to remove from this page access user's visibility.
page_access_user_idstringrequired- The identifier of the page access user whose metrics will be removed.
page_idstringrequired- The identifier of the Statuspage page the access user belongs to.
statuspage_subscriber_unsubscribeUnsubscribe a single subscriber from a Statuspage status page by page ID and subscriber ID.DestructiveUnsubscribe Subscriber
Unsubscribe a single subscriber from a Statuspage status page by page ID and subscriber ID.
- Idempotent
Inputs
page_idstringrequired- The identifier of the Statuspage page the subscriber belongs to
subscriber_idstringrequired- The identifier of the subscriber to unsubscribe
skip_unsubscription_notificationboolean- If true, the subscriber does not receive any notifications when they are unsubscribed
statuspage_subscribers_unsubscribe_bulkUnsubscribe a list of subscribers from a Statuspage status page, optionally filtered by subscriber type and state, or unsubscribe all subscribers (if fewer than 100).DestructiveUnsubscribe Subscribers (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).
- Idempotent
Inputs
page_idstringrequired- The identifier of the Statuspage page the subscribers belong to
subscribersarrayrequired- List 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_notificationboolean- If true, the subscribers do not receive any notifications when they are unsubscribed
statestring- If present, only unsubscribe subscribers in this state. Specify "all" to unsubscribe subscribers in any state.one of
activeunconfirmedquarantinedalldefaultactive typestring- If present, only unsubscribe subscribers of this typeone of
emailsmsslackwebhookteamsintegration_partner
statuspage_user_deleteDelete a user from a Statuspage organization.DestructiveDelete User
Delete a user from a Statuspage organization. This permanently removes the user's access to the organization and its pages.
- Idempotent
Inputs
organization_idstringrequired- The identifier of the Statuspage organization that the user belongs to
user_idstringrequired- The identifier of the user to delete
No tools match.
