Atlassian Statuspage
App · 30 actions
Manage your own status page on Atlassian Statuspage (to read another company's public status page, use the app called Statuspage instead): open incidents and post updates, schedule maintenance, set component statuses and read their uptime, organise components into groups, manage subscribers and record metric data.
Actions
| Action | What it does |
|---|---|
| Add component | Add a component, a part of your service people can see the status of, to a status page. |
| Add component group | Make a group on a status page, optionally putting components in it. |
| Add metric | Add a metric to a metrics source, with its unit and graph range. |
| Add metric data | Record one measurement on a metric, now or at a time you give. |
| Add subscriber | Subscribe an email address, phone number or webhook to a status page's updates, for all components or just some. |
| Delete component | Delete a component from a status page. |
| Delete component group | Delete a component group. |
| Delete incident | Delete an incident or maintenance and all its updates from the page. |
| Delete metric | Delete a metric and all its data from a status page. |
| Delete metrics source | Delete a metrics source and every metric that comes from it. |
| Get component | Get one component with its status, description and group. |
| Get component group | Get one component group with the ids of the components in it. |
| Get component uptime | Get a component's uptime percentage and seconds of partial and major outage over a date range of up to six months. |
| Get incident | Get one incident or maintenance with every update posted to it and the components it affects. |
| Get subscriber | Get one subscriber with how they are notified and the components they follow. |
| List component groups | List the groups that components are organised into on a status page. |
| List components | List the components on a status page with their status and group. |
| List incident templates | List the saved incident and maintenance templates on a status page. |
| List incidents | List incidents and maintenance on a status page: all of them (with a text search), only unresolved incidents, scheduled maintenance, or maintenance in progress. |
| List metrics | List the metrics, such as response time, on a status page. |
| List status pages | List every status page the connected user manages, with its name, address, time zone and subscriber settings. |
| List subscribers | List a status page's subscribers, searched by email, webhook address or phone number and filtered by type or state. |
| Make metrics source | Make the source for metrics you send to Statuspage yourself with 'Add metric data'. |
| Open incident | Open an incident on a status page, optionally marking components affected and notifying subscribers. |
| Post incident update | Move an incident or maintenance to a new status with a message (this posts an update to the page), and optionally change its title, impact, affected components or maintenance window. |
| Schedule maintenance | Schedule maintenance on a status page for a window in the future, optionally reminding subscribers and moving it along by itself. |
| Unsubscribe subscriber | Unsubscribe someone from a status page so they get no more updates. |
| Update component | Rename a component or change its status, description, group or whether it shows on the page. |
| Update component group | Rename a group, change its description or replace the components in it. |
| Update status page | Change a status page's name, website, time zone, search visibility or which kinds of subscriber it allows. |
Add component
Add a component, a part of your service people can see the status of, to a status page.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Name
nametextRequired - The component's name, shown on the page. Up to 255 characters.
- Description
descriptiontext - A longer description, shown when someone hovers over the component.
- Status
statustext - The component's status now. New components start as operational.One of:
operational,degraded_performance(Degraded performance),partial_outage(Partial outage),major_outage(Major outage),under_maintenance(Under maintenance). - Component group
group_idtext - The group to put the component in.
- Show on the page
showcasetrue/false - Whether the component appears on the status page.
- In use since
start_datedate - The day the component went into use. Uptime counts from it.
Outputs
componentobject- The component
Example output
{
"component": {
"automation_email": null,
"created_at": "2026-01-05T09:00:00.000Z",
"description": "Public REST API",
"group": false,
"group_id": null,
"id": "8kbf7d35c070",
"name": "API",
"only_show_if_degraded": false,
"page_id": "gytm4qzbx9t6",
"position": 1,
"showcase": true,
"start_date": "2025-01-01",
"status": "operational",
"updated_at": "2026-10-01T09:00:00.000Z"
}
}Add component group
Make a group on a status page, optionally putting components in it.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Name
nametextRequired - The group's name, shown on the page. Up to 255 characters.
- Description
descriptiontext - A longer description of the group.
- Components
componentslist - The components in the group. A component can be in only one group.
Outputs
groupobject- The component group
Example output
{
"group": {
"components": [
"8kbf7d35c070"
],
"created_at": "2026-01-05T09:00:00.000Z",
"description": "What customers use every day",
"id": "71wd72nz6yy1",
"name": "Core services",
"page_id": "gytm4qzbx9t6",
"position": 1,
"updated_at": "2026-10-01T09:00:00.000Z"
}
}Add metric
Add a metric to a metrics source, with its unit and graph range.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Metrics source
source_idtextRequired - Where the metric's data comes from. Pick one, or give its id from 'Make a metrics source'.
- Name
nametextRequired - The metric's name, shown on the page. Up to 255 characters.
- Unit
suffixtext - The unit shown after each value, such as ms or %.
- Decimal places
decimal_placesnumber - How many decimals to show, 0 to 10.From 0 to 10.
- Graph minimum
y_axis_minnumber - The lowest value on the graph.
- Graph maximum
y_axis_maxnumber - The highest value on the graph.
- Show on the page
displaytrue/false - Whether the metric's graph appears on the status page.
Outputs
metricobject- The metric
Example output
{
"metric": {
"backfill_percentage": null,
"backfilled": null,
"created_at": "2026-10-30T12:00:00.000Z",
"decimal_places": 1,
"display": true,
"id": "met3stu89vwx",
"last_fetched_at": null,
"metric_identifier": "api-response-time",
"metrics_provider_id": "prov1yz234ab",
"most_recent_data_at": null,
"name": "API response time",
"reference_name": null,
"suffix": "ms",
"tooltip_description": null,
"updated_at": "2026-10-30T12:00:00.000Z",
"y_axis_hidden": null,
"y_axis_max": 1000,
"y_axis_min": 0
}
}Add metric data
Record one measurement on a metric, now or at a time you give. Statuspage draws it on the metric's graph.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Metric
metric_idtextRequired - The metric. Pick one, or give its id from an earlier step.
- Value
valuenumberRequired - The measurement to record.
- Measured at
timestampdate and time - When it was measured. Defaults to now.
Outputs
addedtrue/false- True once recorded
metric_idtext- The metric
resultobject- What Statuspage answered
timestampnumber- When it was measured, in Unix seconds
valuenumber- The value recorded
Example output
{
"added": true,
"metric_id": "met3stu89vwx",
"result": {},
"timestamp": 1788000000,
"value": 123.5
}Add subscriber
Subscribe an email address, phone number or webhook to a status page's updates, for all components or just some. Statuspage emails or texts new subscribers to confirm unless you skip it.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Type
subscriber_typetext - How the subscriber is notified. Defaults to email.One of:
email,sms(Text message (SMS)),webhook. - Email address
emailtext - The address to notify. A webhook subscriber also needs one, to send problems to.Only when Type is Email or Webhook.
- Webhook address
endpointtext - The https:// address Statuspage posts updates to.Only when Type is Webhook.
- Phone country
phone_countrytext - The two-letter country the number is in, such as US.Only when Type is Text message (SMS).
- Phone number
phone_numbertext - The number as dialled in that country, without the country code.Only when Type is Text message (SMS).
- Only these components
component_idslist - Notify only about these components. Leave empty for all of them.
- Skip the confirmation message
skip_confirmation_notificationtrue/false - Subscribe them without sending the 'you are subscribed' message.
Outputs
subscriberobject- The subscriber
Example output
{
"subscriber": {
"components": [],
"created_at": "2026-10-30T12:00:00.000Z",
"display_phone_number": null,
"email": "oncall@example.com",
"endpoint": null,
"id": "sub9xyz12abc",
"mode": "email",
"page_access_user_id": null,
"phone_country": null,
"phone_number": null,
"purge_at": null,
"quarantined_at": null,
"skip_confirmation_notification": true
}
}Delete component
Delete a component from a status page.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Component
component_idtextRequired - The component. Pick one, or give its id from an earlier step.
Outputs
componentobject- The record as it was, if Statuspage sent it back
component_idtext- The id that was deleted
deletedtrue/false- Always true once deleted
Example output
{
"component": {
"automation_email": null,
"created_at": "2026-01-05T09:00:00.000Z",
"description": "Public REST API",
"group": false,
"group_id": null,
"id": "8kbf7d35c070",
"name": "API",
"only_show_if_degraded": false,
"page_id": "gytm4qzbx9t6",
"position": 1,
"showcase": true,
"start_date": "2025-01-01",
"status": "operational",
"updated_at": "2026-10-01T09:00:00.000Z"
},
"component_id": "8kbf7d35c070",
"deleted": true
}Delete component group
Delete a component group. Check on the page afterwards whether its components were kept.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Component group
group_idtextRequired - The component group. Pick one, or give its id from an earlier step.
Outputs
deletedtrue/false- Always true once deleted
groupobject- The record as it was, if Statuspage sent it back
group_idtext- The id that was deleted
Example output
{
"deleted": true,
"group": {
"components": [
"8kbf7d35c070"
],
"created_at": "2026-01-05T09:00:00.000Z",
"description": "What customers use every day",
"id": "71wd72nz6yy1",
"name": "Core services",
"page_id": "gytm4qzbx9t6",
"position": 1,
"updated_at": "2026-10-01T09:00:00.000Z"
},
"group_id": "71wd72nz6yy1"
}Delete incident
Delete an incident or maintenance and all its updates from the page.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Incident
incident_idtextRequired - The incident or maintenance. Pick one, or give its id from an earlier step.
Outputs
deletedtrue/false- Always true once deleted
incidentobject- The record as it was, if Statuspage sent it back
incident_idtext- The id that was deleted
Example output
{
"deleted": true,
"incident": {
"auto_transition_to_maintenance_state": null,
"auto_transition_to_operational_state": null,
"components": [
{
"automation_email": null,
"created_at": "2026-01-05T09:00:00.000Z",
"description": "Public REST API",
"group": false,
"group_id": null,
"id": "8kbf7d35c070",
"name": "API",
"only_show_if_degraded": false,
"page_id": "gytm4qzbx9t6",
"position": 1,
"showcase": true,
"start_date": "2025-01-01",
"status": "operational",
"updated_at": "2026-10-01T09:00:00.000Z"
}
],
"created_at": "2026-10-30T12:00:00.000Z",
"id": "p31zjtct2jer",
"impact": "minor",
"impact_override": null,
"incident_updates": [
{
"affected_components": [],
"body": "We are looking into it.",
"created_at": "2026-10-30T12:00:00.000Z",
"deliver_notifications": true,
"display_at": "2026-10-30T12:00:00.000Z",
"id": "upd1abc23def",
"incident_id": "p31zjtct2jer",
"status": "investigating",
"updated_at": "2026-10-30T12:00:00.000Z"
}
],
"metadata": {},
"monitoring_at": null,
"name": "Elevated API errors",
"page_id": "gytm4qzbx9t6",
"postmortem_body": null,
"postmortem_ignored": null,
"resolved_at": null,
"scheduled_auto_completed": null,
"scheduled_auto_in_progress": null,
"scheduled_for": null,
"scheduled_remind_prior": null,
"scheduled_until": null,
"shortlink": "http://stspg.io/803310a12",
"status": "investigating",
"updated_at": "2026-10-30T12:00:00.000Z"
},
"incident_id": "p31zjtct2jer"
}Delete metric
Delete a metric and all its data from a status page.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Metric
metric_idtextRequired - The metric. Pick one, or give its id from an earlier step.
Outputs
deletedtrue/false- Always true once deleted
metricobject- The record as it was, if Statuspage sent it back
metric_idtext- The id that was deleted
Example output
{
"deleted": true,
"metric": {
"backfill_percentage": null,
"backfilled": null,
"created_at": "2026-10-30T12:00:00.000Z",
"decimal_places": 1,
"display": true,
"id": "met3stu89vwx",
"last_fetched_at": null,
"metric_identifier": "api-response-time",
"metrics_provider_id": "prov1yz234ab",
"most_recent_data_at": null,
"name": "API response time",
"reference_name": null,
"suffix": "ms",
"tooltip_description": null,
"updated_at": "2026-10-30T12:00:00.000Z",
"y_axis_hidden": null,
"y_axis_max": 1000,
"y_axis_min": 0
},
"metric_id": "met3stu89vwx"
}Delete metrics source
Delete a metrics source and every metric that comes from it.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Metrics source
source_idtextRequired - Where the metric's data comes from. Pick one, or give its id from 'Make a metrics source'.
Outputs
deletedtrue/false- Always true once deleted
providerobject- The record as it was, if Statuspage sent it back
source_idtext- The id that was deleted
Example output
{
"deleted": true,
"provider": {
"created_at": "2026-10-30T12:00:00.000Z",
"disabled": false,
"id": "prov1yz234ab",
"last_revalidated_at": null,
"metric_base_uri": null,
"page_id": "gytm4qzbx9t6",
"type": "Self",
"updated_at": "2026-10-30T12:00:00.000Z"
},
"source_id": "prov1yz234ab"
}Get component
Get one component with its status, description and group.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Component
component_idtextRequired - The component. Pick one, or give its id from an earlier step.
Outputs
componentobject- The component
Example output
{
"component": {
"automation_email": null,
"created_at": "2026-01-05T09:00:00.000Z",
"description": "Public REST API",
"group": false,
"group_id": null,
"id": "8kbf7d35c070",
"name": "API",
"only_show_if_degraded": false,
"page_id": "gytm4qzbx9t6",
"position": 1,
"showcase": true,
"start_date": "2025-01-01",
"status": "operational",
"updated_at": "2026-10-01T09:00:00.000Z"
}
}Get component group
Get one component group with the ids of the components in it.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Component group
group_idtextRequired - The component group. Pick one, or give its id from an earlier step.
Outputs
groupobject- The component group
Example output
{
"group": {
"components": [
"8kbf7d35c070"
],
"created_at": "2026-01-05T09:00:00.000Z",
"description": "What customers use every day",
"id": "71wd72nz6yy1",
"name": "Core services",
"page_id": "gytm4qzbx9t6",
"position": 1,
"updated_at": "2026-10-01T09:00:00.000Z"
}
}Get component uptime
Get a component's uptime percentage and seconds of partial and major outage over a date range of up to six months. The component must be shown on the page.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Component
component_idtextRequired - The component. Pick one, or give its id from an earlier step.
- From
start_datedate - First day to count. Defaults to the component's start date or 90 days ago, whichever is later.
- Until
end_datedate - Last day to count, at most six months after the first. Defaults to today.
- Leave out related incidents
skip_related_eventstrue/false - Return only the totals, without the incidents behind them.
Outputs
uptimeobject- The uptime figures
Example output
{
"uptime": {
"id": "8kbf7d35c070",
"major_outage": 0,
"name": "API",
"partial_outage": 2400,
"range_end": "2026-10-30",
"range_start": "2026-08-01",
"related_events": [],
"uptime_percentage": 99.95,
"warnings": []
}
}Get incident
Get one incident or maintenance with every update posted to it and the components it affects.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Incident
incident_idtextRequired - The incident or maintenance. Pick one, or give its id from an earlier step.
Outputs
incidentobject- The incident or maintenance
Example output
{
"incident": {
"auto_transition_to_maintenance_state": null,
"auto_transition_to_operational_state": null,
"components": [
{
"automation_email": null,
"created_at": "2026-01-05T09:00:00.000Z",
"description": "Public REST API",
"group": false,
"group_id": null,
"id": "8kbf7d35c070",
"name": "API",
"only_show_if_degraded": false,
"page_id": "gytm4qzbx9t6",
"position": 1,
"showcase": true,
"start_date": "2025-01-01",
"status": "operational",
"updated_at": "2026-10-01T09:00:00.000Z"
}
],
"created_at": "2026-10-30T12:00:00.000Z",
"id": "p31zjtct2jer",
"impact": "minor",
"impact_override": null,
"incident_updates": [
{
"affected_components": [],
"body": "We are looking into it.",
"created_at": "2026-10-30T12:00:00.000Z",
"deliver_notifications": true,
"display_at": "2026-10-30T12:00:00.000Z",
"id": "upd1abc23def",
"incident_id": "p31zjtct2jer",
"status": "investigating",
"updated_at": "2026-10-30T12:00:00.000Z"
}
],
"metadata": {},
"monitoring_at": null,
"name": "Elevated API errors",
"page_id": "gytm4qzbx9t6",
"postmortem_body": null,
"postmortem_ignored": null,
"resolved_at": null,
"scheduled_auto_completed": null,
"scheduled_auto_in_progress": null,
"scheduled_for": null,
"scheduled_remind_prior": null,
"scheduled_until": null,
"shortlink": "http://stspg.io/803310a12",
"status": "investigating",
"updated_at": "2026-10-30T12:00:00.000Z"
}
}Get subscriber
Get one subscriber with how they are notified and the components they follow.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Subscriber ID
subscriber_idtextRequired - The subscriber's id, from 'List subscribers' or 'Add subscriber'.
Outputs
subscriberobject- The subscriber
Example output
{
"subscriber": {
"components": [],
"created_at": "2026-10-30T12:00:00.000Z",
"display_phone_number": null,
"email": "oncall@example.com",
"endpoint": null,
"id": "sub9xyz12abc",
"mode": "email",
"page_access_user_id": null,
"phone_country": null,
"phone_number": null,
"purge_at": null,
"quarantined_at": null,
"skip_confirmation_notification": true
}
}List component groups
List the groups that components are organised into on a status page.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Page number
pagenumber - Which page of results to get, starting at 1. Defaults to the first.At least 1.
- Page size
per_pagenumber - How many to return, 1 to 100. Statuspage's default is 100.From 1 to 100.
Outputs
countnumber- How many came back on this page
groupslist- The component groups
has_moretrue/false- True when the page was full, so a next page may exist
pagenumber- The page number asked for, empty if none was given
Example output
{
"count": 1,
"groups": [
{
"components": [
"8kbf7d35c070"
],
"created_at": "2026-01-05T09:00:00.000Z",
"description": "What customers use every day",
"id": "71wd72nz6yy1",
"name": "Core services",
"page_id": "gytm4qzbx9t6",
"position": 1,
"updated_at": "2026-10-01T09:00:00.000Z"
}
],
"has_more": false,
"page": 1
}List components
List the components on a status page with their status and group. Gets one page; to see more, run it again with the next page number.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Page number
pagenumber - Which page of results to get, starting at 1. Defaults to the first.At least 1.
- Page size
per_pagenumber - How many to return, 1 to 100. Statuspage's default is 100.From 1 to 100.
Outputs
componentslist- The components
countnumber- How many came back on this page
has_moretrue/false- True when the page was full, so a next page may exist
pagenumber- The page number asked for, empty if none was given
Example output
{
"components": [
{
"automation_email": null,
"created_at": "2026-01-05T09:00:00.000Z",
"description": "Public REST API",
"group": false,
"group_id": null,
"id": "8kbf7d35c070",
"name": "API",
"only_show_if_degraded": false,
"page_id": "gytm4qzbx9t6",
"position": 1,
"showcase": true,
"start_date": "2025-01-01",
"status": "operational",
"updated_at": "2026-10-01T09:00:00.000Z"
}
],
"count": 1,
"has_more": false,
"page": 1
}List incident templates
List the saved incident and maintenance templates on a status page.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Page number
pagenumber - Which page of results to get, starting at 1. Defaults to the first.At least 1.
- Page size
per_pagenumber - How many to return, 1 to 100. Statuspage's default is 100.From 1 to 100.
Outputs
countnumber- How many came back on this page
has_moretrue/false- True when the page was full, so a next page may exist
pagenumber- The page number asked for, empty if none was given
templateslist- The templates
Example output
{
"count": 1,
"has_more": false,
"page": 1,
"templates": [
{
"body": "We are upgrading our database.",
"components": [],
"group_id": null,
"id": "tpl5mno67pqr",
"name": "Database maintenance",
"should_send_notifications": true,
"should_tweet": false,
"title": "Scheduled database maintenance",
"update_status": "scheduled"
}
]
}List incidents
List incidents and maintenance on a status page: all of them (with a text search), only unresolved incidents, scheduled maintenance, or maintenance in progress. Gets one page; to see more, run it again with the next page number.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Which
whichtext - Which incidents to list. Defaults to all incidents and maintenance.One of:
all(All incidents and maintenance (default)),unresolved(Unresolved incidents),scheduled(Scheduled maintenance),active_maintenance(Maintenance in progress). - Search
querytext - Only incidents whose name, status, postmortem or updates contain this text. Works with 'All incidents and maintenance' only.
- Page number
pagenumber - Which page of results to get, starting at 1. Defaults to the first.At least 1.
- Page size
per_pagenumber - How many to return, 1 to 100. Statuspage's default is 100.From 1 to 100.
Outputs
countnumber- How many came back on this page
has_moretrue/false- True when the page was full, so a next page may exist
incidentslist- The incidents and maintenance
pagenumber- The page number asked for, empty if none was given
Example output
{
"count": 1,
"has_more": false,
"incidents": [
{
"auto_transition_to_maintenance_state": null,
"auto_transition_to_operational_state": null,
"components": [
{
"automation_email": null,
"created_at": "2026-01-05T09:00:00.000Z",
"description": "Public REST API",
"group": false,
"group_id": null,
"id": "8kbf7d35c070",
"name": "API",
"only_show_if_degraded": false,
"page_id": "gytm4qzbx9t6",
"position": 1,
"showcase": true,
"start_date": "2025-01-01",
"status": "operational",
"updated_at": "2026-10-01T09:00:00.000Z"
}
],
"created_at": "2026-10-30T12:00:00.000Z",
"id": "p31zjtct2jer",
"impact": "minor",
"impact_override": null,
"incident_updates": [
{
"affected_components": [],
"body": "We are looking into it.",
"created_at": "2026-10-30T12:00:00.000Z",
"deliver_notifications": true,
"display_at": "2026-10-30T12:00:00.000Z",
"id": "upd1abc23def",
"incident_id": "p31zjtct2jer",
"status": "investigating",
"updated_at": "2026-10-30T12:00:00.000Z"
}
],
"metadata": {},
"monitoring_at": null,
"name": "Elevated API errors",
"page_id": "gytm4qzbx9t6",
"postmortem_body": null,
"postmortem_ignored": null,
"resolved_at": null,
"scheduled_auto_completed": null,
"scheduled_auto_in_progress": null,
"scheduled_for": null,
"scheduled_remind_prior": null,
"scheduled_until": null,
"shortlink": "http://stspg.io/803310a12",
"status": "investigating",
"updated_at": "2026-10-30T12:00:00.000Z"
}
],
"page": 1
}List metrics
List the metrics, such as response time, on a status page.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Page number
pagenumber - Which page of results to get, starting at 1. Defaults to the first.At least 1.
- Page size
per_pagenumber - How many to return, 1 to 100. Statuspage's default is 100.From 1 to 100.
Outputs
countnumber- How many came back on this page
has_moretrue/false- True when the page was full, so a next page may exist
metricslist- The metrics
pagenumber- The page number asked for, empty if none was given
Example output
{
"count": 1,
"has_more": false,
"metrics": [
{
"backfill_percentage": null,
"backfilled": null,
"created_at": "2026-10-30T12:00:00.000Z",
"decimal_places": 1,
"display": true,
"id": "met3stu89vwx",
"last_fetched_at": null,
"metric_identifier": "api-response-time",
"metrics_provider_id": "prov1yz234ab",
"most_recent_data_at": null,
"name": "API response time",
"reference_name": null,
"suffix": "ms",
"tooltip_description": null,
"updated_at": "2026-10-30T12:00:00.000Z",
"y_axis_hidden": null,
"y_axis_max": 1000,
"y_axis_min": 0
}
],
"page": 1
}List status pages
List every status page the connected user manages, with its name, address, time zone and subscriber settings.
Inputs
None.
Outputs
countnumber- How many pages there are
pageslist- The status pages
Example output
{
"count": 1,
"pages": [
{
"allow_email_subscribers": true,
"allow_incident_subscribers": true,
"allow_page_subscribers": true,
"allow_rss_atom_feeds": true,
"allow_sms_subscribers": true,
"allow_webhook_subscribers": true,
"branding": null,
"city": null,
"country": null,
"created_at": "2026-01-05T09:00:00.000Z",
"domain": null,
"headline": null,
"hidden_from_search": false,
"id": "gytm4qzbx9t6",
"name": "Acme Status",
"notifications_email_footer": null,
"notifications_from_email": null,
"page_description": null,
"state": null,
"subdomain": "acme",
"support_url": null,
"time_zone": "UTC",
"updated_at": "2026-10-01T09:00:00.000Z",
"url": "https://www.acme.example"
}
]
}List subscribers
List a status page's subscribers, searched by email, webhook address or phone number and filtered by type or state. Gets one page; to see more, run it again with the next page number.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Search
querytext - Only subscribers whose email, webhook address or phone contains this.
- Type
subscriber_typetext - Only subscribers of this type.One of:
email,sms(Text message (SMS)),webhook,slack,teams(Microsoft Teams),integration_partner(Integration partner). - State
statetext - Only subscribers in this state. Defaults to active.One of:
active(Active (default)),unconfirmed,quarantined,all(Any state). - Page number
pagenumber - Which page of results to get, starting at 0. Defaults to the first.At least 0.
- Page size
limitnumber - How many to return, 1 to 100. Statuspage's default is 100.From 1 to 100.
Outputs
countnumber- How many came back on this page
has_moretrue/false- True when the page was full, so a next page may exist
pagenumber- The page number asked for, empty if none was given
subscriberslist- The subscribers
Example output
{
"count": 1,
"has_more": false,
"page": 0,
"subscribers": [
{
"components": [],
"created_at": "2026-10-30T12:00:00.000Z",
"display_phone_number": null,
"email": "oncall@example.com",
"endpoint": null,
"id": "sub9xyz12abc",
"mode": "email",
"page_access_user_id": null,
"phone_country": null,
"phone_number": null,
"purge_at": null,
"quarantined_at": null,
"skip_confirmation_notification": true
}
]
}Make metrics source
Make the source for metrics you send to Statuspage yourself with 'Add metric data'. A page has one, so if it is already there that one is returned. Metrics need a plan that includes them.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
Outputs
createdtrue/false- False when the page already had the source
providerobject- The source
Example output
{
"created": true,
"provider": {
"created_at": "2026-10-30T12:00:00.000Z",
"disabled": false,
"id": "prov1yz234ab",
"last_revalidated_at": null,
"metric_base_uri": null,
"page_id": "gytm4qzbx9t6",
"type": "Self",
"updated_at": "2026-10-30T12:00:00.000Z"
}
}Open incident
Open an incident on a status page, optionally marking components affected and notifying subscribers. Turn off 'Notify subscribers' to post it quietly.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Title
nametextRequired - What the incident is, shown on the page. Up to 255 characters.
- Status
statustext - Where the incident stands. Defaults to Investigating.One of:
investigating,identified,monitoring,resolved. - Message
bodytext - The first update, shown to visitors and sent to subscribers.
- Impact
impact_overridetext - How serious it is. Leave empty to let Statuspage work it out from the components' statuses.One of:
none,minor,major,critical,maintenance. - Affected components
component_idslist - The components this is about.
- Set affected components to
component_statustext - The status to give every affected component. Leave empty to leave their status as it is.One of:
operational,degraded_performance(Degraded performance),partial_outage(Partial outage),major_outage(Major outage),under_maintenance(Under maintenance). - Notify subscribers
deliver_notificationstrue/false - Email and text the page's subscribers about this. Left blank, subscribers are notified, as when it is on. Off sends nothing.
Outputs
incidentobject- The incident or maintenance
Example output
{
"incident": {
"auto_transition_to_maintenance_state": null,
"auto_transition_to_operational_state": null,
"components": [
{
"automation_email": null,
"created_at": "2026-01-05T09:00:00.000Z",
"description": "Public REST API",
"group": false,
"group_id": null,
"id": "8kbf7d35c070",
"name": "API",
"only_show_if_degraded": false,
"page_id": "gytm4qzbx9t6",
"position": 1,
"showcase": true,
"start_date": "2025-01-01",
"status": "operational",
"updated_at": "2026-10-01T09:00:00.000Z"
}
],
"created_at": "2026-10-30T12:00:00.000Z",
"id": "p31zjtct2jer",
"impact": "minor",
"impact_override": null,
"incident_updates": [
{
"affected_components": [],
"body": "We are looking into it.",
"created_at": "2026-10-30T12:00:00.000Z",
"deliver_notifications": true,
"display_at": "2026-10-30T12:00:00.000Z",
"id": "upd1abc23def",
"incident_id": "p31zjtct2jer",
"status": "investigating",
"updated_at": "2026-10-30T12:00:00.000Z"
}
],
"metadata": {},
"monitoring_at": null,
"name": "Elevated API errors",
"page_id": "gytm4qzbx9t6",
"postmortem_body": null,
"postmortem_ignored": null,
"resolved_at": null,
"scheduled_auto_completed": null,
"scheduled_auto_in_progress": null,
"scheduled_for": null,
"scheduled_remind_prior": null,
"scheduled_until": null,
"shortlink": "http://stspg.io/803310a12",
"status": "investigating",
"updated_at": "2026-10-30T12:00:00.000Z"
}
}Post incident update
Move an incident or maintenance to a new status with a message (this posts an update to the page), and optionally change its title, impact, affected components or maintenance window.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Incident
incident_idtextRequired - The incident or maintenance. Pick one, or give its id from an earlier step.
- Status
statustext - The new status. Resolved closes an incident; Completed finishes maintenance. Leave empty to keep it.One of:
investigating,identified,monitoring,resolved,scheduled,in_progress(In progress),verifying,completed. - Message
bodytext - The update to show visitors and send to subscribers.
- Title
nametext - A new title. Leave empty to keep it.
- Impact
impact_overridetext - A new impact. Leave empty to keep it.One of:
none,minor,major,critical,maintenance. - Affected components
component_idslist - The components this is about.
- Set affected components to
component_statustext - The status to give every affected component. Leave empty to leave their status as it is.One of:
operational,degraded_performance(Degraded performance),partial_outage(Partial outage),major_outage(Major outage),under_maintenance(Under maintenance). - New start
scheduled_fordate and time - For maintenance: a new start time.
- New end
scheduled_untildate and time - For maintenance: a new end time.
- Notify subscribers
deliver_notificationstrue/false - Email and text the page's subscribers about this. Left blank, subscribers are notified, as when it is on. Off sends nothing.
Outputs
incidentobject- The incident or maintenance
Example output
{
"incident": {
"auto_transition_to_maintenance_state": null,
"auto_transition_to_operational_state": null,
"components": [
{
"automation_email": null,
"created_at": "2026-01-05T09:00:00.000Z",
"description": "Public REST API",
"group": false,
"group_id": null,
"id": "8kbf7d35c070",
"name": "API",
"only_show_if_degraded": false,
"page_id": "gytm4qzbx9t6",
"position": 1,
"showcase": true,
"start_date": "2025-01-01",
"status": "operational",
"updated_at": "2026-10-01T09:00:00.000Z"
}
],
"created_at": "2026-10-30T12:00:00.000Z",
"id": "p31zjtct2jer",
"impact": "minor",
"impact_override": null,
"incident_updates": [
{
"affected_components": [],
"body": "We are looking into it.",
"created_at": "2026-10-30T12:00:00.000Z",
"deliver_notifications": true,
"display_at": "2026-10-30T12:00:00.000Z",
"id": "upd1abc23def",
"incident_id": "p31zjtct2jer",
"status": "investigating",
"updated_at": "2026-10-30T12:00:00.000Z"
}
],
"metadata": {},
"monitoring_at": null,
"name": "Elevated API errors",
"page_id": "gytm4qzbx9t6",
"postmortem_body": null,
"postmortem_ignored": null,
"resolved_at": null,
"scheduled_auto_completed": null,
"scheduled_auto_in_progress": null,
"scheduled_for": null,
"scheduled_remind_prior": null,
"scheduled_until": null,
"shortlink": "http://stspg.io/803310a12",
"status": "identified",
"updated_at": "2026-10-30T12:00:00.000Z"
}
}Schedule maintenance
Schedule maintenance on a status page for a window in the future, optionally reminding subscribers and moving it along by itself.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Title
nametextRequired - What the maintenance is, shown on the page. Up to 255 characters.
- Starts
scheduled_fordate and timeRequired - When the maintenance begins. It must be in the future.
- Ends
scheduled_untildate and timeRequired - When the maintenance is due to finish.
- Message
bodytext - What visitors are told about the maintenance.
- Affected components
component_idslist - The components the maintenance affects.
- Remind subscribers beforehand
remind_subscriberstrue/false - Email subscribers a reminder before the maintenance starts.
- Start automatically
start_automaticallytrue/false - Move the maintenance to In progress when it is due.
- Complete automatically
complete_automaticallytrue/false - Move the maintenance to Completed when it is due to end.
- Mark components under maintenance
mark_components_under_maintenancetrue/false - Set the affected components to Under maintenance when it starts.
- Mark components operational
mark_components_operationaltrue/false - Set the affected components to Operational when it ends.
- Notify subscribers
deliver_notificationstrue/false - Email and text the page's subscribers about this. Left blank, subscribers are notified, as when it is on. Off sends nothing.
Outputs
incidentobject- The incident or maintenance
Example output
{
"incident": {
"auto_transition_to_maintenance_state": null,
"auto_transition_to_operational_state": null,
"components": [
{
"automation_email": null,
"created_at": "2026-01-05T09:00:00.000Z",
"description": "Public REST API",
"group": false,
"group_id": null,
"id": "8kbf7d35c070",
"name": "API",
"only_show_if_degraded": false,
"page_id": "gytm4qzbx9t6",
"position": 1,
"showcase": true,
"start_date": "2025-01-01",
"status": "operational",
"updated_at": "2026-10-01T09:00:00.000Z"
}
],
"created_at": "2026-10-30T12:00:00.000Z",
"id": "p31zjtct2jer",
"impact": "minor",
"impact_override": null,
"incident_updates": [
{
"affected_components": [],
"body": "We are looking into it.",
"created_at": "2026-10-30T12:00:00.000Z",
"deliver_notifications": true,
"display_at": "2026-10-30T12:00:00.000Z",
"id": "upd1abc23def",
"incident_id": "p31zjtct2jer",
"status": "investigating",
"updated_at": "2026-10-30T12:00:00.000Z"
}
],
"metadata": {},
"monitoring_at": null,
"name": "Database upgrade",
"page_id": "gytm4qzbx9t6",
"postmortem_body": null,
"postmortem_ignored": null,
"resolved_at": null,
"scheduled_auto_completed": null,
"scheduled_auto_in_progress": null,
"scheduled_for": "2026-11-20T02:00:00.000Z",
"scheduled_remind_prior": null,
"scheduled_until": "2026-11-20T03:00:00.000Z",
"shortlink": "http://stspg.io/803310a12",
"status": "scheduled",
"updated_at": "2026-10-30T12:00:00.000Z"
}
}Unsubscribe subscriber
Unsubscribe someone from a status page so they get no more updates.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Subscriber ID
subscriber_idtextRequired - The subscriber's id, from 'List subscribers' or 'Add subscriber'.
- Skip the goodbye message
skip_unsubscription_notificationtrue/false - Unsubscribe them without telling them.
Outputs
deletedtrue/false- Always true once deleted
subscriberobject- The record as it was, if Statuspage sent it back
subscriber_idtext- The id that was deleted
Example output
{
"deleted": true,
"subscriber": {
"components": [],
"created_at": "2026-10-30T12:00:00.000Z",
"display_phone_number": null,
"email": "oncall@example.com",
"endpoint": null,
"id": "sub9xyz12abc",
"mode": "email",
"page_access_user_id": null,
"phone_country": null,
"phone_number": null,
"purge_at": null,
"quarantined_at": null,
"skip_confirmation_notification": true
},
"subscriber_id": "sub9xyz12abc"
}Update component
Rename a component or change its status, description, group or whether it shows on the page. Only what you fill in changes. Changing the status here does not post an incident or notify subscribers.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Component
component_idtextRequired - The component. Pick one, or give its id from an earlier step.
- Name
nametext - A new name. Leave empty to keep it.
- Description
descriptiontext - A longer description, shown when someone hovers over the component.
- Status
statustext - The component's status now. New components start as operational.One of:
operational,degraded_performance(Degraded performance),partial_outage(Partial outage),major_outage(Major outage),under_maintenance(Under maintenance). - Component group
group_idtext - The group to put the component in.
- Show on the page
showcasetrue/false - Whether the component appears on the status page.
- In use since
start_datedate - The day the component went into use. Uptime counts from it.
Outputs
componentobject- The component
Example output
{
"component": {
"automation_email": null,
"created_at": "2026-01-05T09:00:00.000Z",
"description": "Public REST API",
"group": false,
"group_id": null,
"id": "8kbf7d35c070",
"name": "API",
"only_show_if_degraded": false,
"page_id": "gytm4qzbx9t6",
"position": 1,
"showcase": true,
"start_date": "2025-01-01",
"status": "operational",
"updated_at": "2026-10-01T09:00:00.000Z"
}
}Update component group
Rename a group, change its description or replace the components in it. Only what you fill in changes.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Component group
group_idtextRequired - The component group. Pick one, or give its id from an earlier step.
- Name
nametext - A new name. Leave empty to keep it.
- Description
descriptiontext - A new description. Leave empty to keep it.
- Components
componentslist - Replaces the components in the group with these. Leave empty to keep the group's components as they are.
Outputs
groupobject- The component group
Example output
{
"group": {
"components": [
"8kbf7d35c070"
],
"created_at": "2026-01-05T09:00:00.000Z",
"description": "What customers use every day",
"id": "71wd72nz6yy1",
"name": "Core services",
"page_id": "gytm4qzbx9t6",
"position": 1,
"updated_at": "2026-10-01T09:00:00.000Z"
}
}Update status page
Change a status page's name, website, time zone, search visibility or which kinds of subscriber it allows. Only what you fill in changes.
Inputs
- Status page
page_idtextRequired - The status page. Pick one, or give its id from an earlier step.
- Name
nametext - A new name for the page. Leave empty to keep it. Up to 255 characters.
- Company website
urltext - The address the page's logo links to. Leave empty to keep it.
- Time zone
time_zonetext - The page's time zone, such as UTC or America/New_York.
- Hide from search engines
hidden_from_searchtrue/false - Ask search engines not to list the page.
- Allow subscribing to the page
allow_page_subscriberstrue/false - Let visitors subscribe to every update on the page.
- Allow subscribing to one incident
allow_incident_subscriberstrue/false - Let visitors subscribe to a single incident.
- Allow email subscribers
allow_email_subscriberstrue/false - Let visitors choose email notifications.
- Allow text message subscribers
allow_sms_subscriberstrue/false - Let visitors choose text message notifications.
- Allow webhook subscribers
allow_webhook_subscriberstrue/false - Let visitors choose webhook notifications.
- Allow RSS and Atom feeds
allow_rss_atom_feedstrue/false - Let visitors follow incidents in a feed reader.
- Email footer
notifications_email_footertext - Text added to the end of notification emails. Markdown works.
Outputs
pageobject- The page after the change
Example output
{
"page": {
"allow_email_subscribers": true,
"allow_incident_subscribers": true,
"allow_page_subscribers": true,
"allow_rss_atom_feeds": true,
"allow_sms_subscribers": true,
"allow_webhook_subscribers": true,
"branding": null,
"city": null,
"country": null,
"created_at": "2026-01-05T09:00:00.000Z",
"domain": null,
"headline": null,
"hidden_from_search": false,
"id": "gytm4qzbx9t6",
"name": "Acme Status",
"notifications_email_footer": null,
"notifications_from_email": null,
"page_description": null,
"state": null,
"subdomain": "acme",
"support_url": null,
"time_zone": "UTC",
"updated_at": "2026-10-01T09:00:00.000Z",
"url": "https://www.acme.example"
}
}