manage_status_page
Create, update, and delete status page incidents, maintenance windows, components, and subscribers to keep customers informed during outages and planned work.
Instructions
Unified Status Page operations: maintenance windows, incidents, components.
IMPORTANT — Publishing a maintenance on the Status Page:
To publish a maintenance, you MUST provide either change_id or
maintenance_window_id. The rules are:
1. If the Change already has a maintenance_window (check via
manage_change action='get' → maintenance_window.id), use change_id.
2. If the Change has NO maintenance_window (maintenance_window is
empty {}), you MUST first create a Maintenance Window using
manage_maintenance_window action='create' with name, description,
start_time, end_time, AND change_id (to auto-associate the MW
with the Change). Then use the returned maintenance_window_id here.
3. You can also use maintenance_window_id directly if you already
know the MW ID.
Required fields for create_maintenance:
- title, description, started_at, ended_at, impacted_services
- impacted_services format: [{"id": <service_component_id>, "status": 5}]
status values: 1=Operational, 5=Under maintenance, 10=Degraded,
20=Partial outage, 30=Major outage
- Get available service component IDs via action='list_components'
Args:
action: One of:
Pages: 'list_pages'
Components: 'list_components', 'get_component'
Maintenance: 'list_maintenance', 'create_maintenance', 'update_maintenance',
'get_maintenance', 'delete_maintenance'
Maintenance Updates: 'create_maintenance_update', 'list_maintenance_updates',
'update_maintenance_update', 'delete_maintenance_update'
Incidents: 'list_incidents', 'create_incident', 'update_incident',
'get_incident', 'delete_incident'
Incident Updates: 'create_incident_update', 'list_incident_updates',
'update_incident_update', 'delete_incident_update'
Statuses: 'list_incident_statuses', 'list_maintenance_statuses'
Subscribers: 'list_subscribers', 'get_subscriber', 'create_subscriber',
'update_subscriber', 'delete_subscriber'
status_page_id: Status page ID (auto-discovered if omitted).
change_id: Change ID — maintenance CRUD from a change. The change
MUST have an associated maintenance_window or the API returns 404.
Check via manage_change get → if maintenance_window is empty {},
use manage_maintenance_window to create one first, then pass
maintenance_window_id instead.
maintenance_window_id: Maintenance Window ID — maintenance CRUD from a MW.
Use this when the change has no built-in MW, or for standalone MW
publishing. Create a MW first via manage_maintenance_window action='create'.
ticket_id: Ticket ID — incident CRUD (required for create/update/get/delete,
not needed for list_incidents).
maintenance_id: Maintenance ID (get/update/delete maintenance, maintenance updates)
incident_id: Incident ID (get/update/delete incident, incident updates)
update_id: Update ID (update/delete maintenance/incident updates)
component_id: Service component ID (get_component)
subscriber_id: Subscriber ID (get/update/delete subscriber)
title: Title (create maintenance/incident) — Mandatory
description: HTML description
started_at: ISO datetime — start time (maintenance/incident)
ended_at: ISO datetime — end time (maintenance)
impacted_services: [{id, status}] — 1=Operational, 5=Under maintenance,
10=Degraded, 20=Partial outage, 30=Major outage — Mandatory for create_maintenance
notifications: Array of notification dicts [{trigger, options: {value}}]
trigger: 1=On start, 2=Before start, 3=On complete
is_private: Private maintenance/incident (default false)
body: Update body text (maintenance/incident updates)
update_status: Status string for updates
email: Subscriber email (create_subscriber — Mandatory)
service_ids: List of service IDs the subscriber is subscribed to
subscribe_all_services: true = notify for all services
subscriber_type: 1=External, 2=Agent, 3=Requester
timezone: Subscriber timezone (e.g. "UTC")
page/per_page: Pagination
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | ||
| page | No | ||
| No | |||
| title | No | ||
| action | Yes | ||
| ended_at | No | ||
| per_page | No | ||
| timezone | No | ||
| change_id | No | ||
| ticket_id | No | ||
| update_id | No | ||
| is_private | No | ||
| started_at | No | ||
| description | No | ||
| incident_id | No | ||
| service_ids | No | ||
| component_id | No | ||
| notifications | No | ||
| subscriber_id | No | ||
| update_status | No | ||
| maintenance_id | No | ||
| status_page_id | No | ||
| subscriber_type | No | ||
| impacted_services | No | ||
| maintenance_window_id | No | ||
| subscribe_all_services | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |