Skip to main content

Status Pages

Status Pages let you communicate service health and incidents to your customers. These tools let you read status page configuration and create posts and updates.

Toolsโ€‹

list_status_pagesโ€‹

List Status Pages with optional filtering.

ParameterTypeRequiredDescription
query_modelStatusPageQueryNoOptional filtering parameters

list_status_page_severitiesโ€‹

List severity levels for a Status Page.

ParameterTypeRequiredDescription
status_page_idstringYesThe ID of the Status Page
query_modelStatusPageSeverityQueryNoOptional filtering parameters

list_status_page_impactsโ€‹

List impact options for a Status Page.

ParameterTypeRequiredDescription
status_page_idstringYesThe ID of the Status Page
query_modelStatusPageImpactQueryNoOptional filtering parameters

list_status_page_statusesโ€‹

List status options for a Status Page.

ParameterTypeRequiredDescription
status_page_idstringYesThe ID of the Status Page
query_modelStatusPageStatusQueryNoOptional filtering parameters

get_status_page_postโ€‹

Get a specific status page post by post ID.

ParameterTypeRequiredDescription
status_page_idstringYesThe ID of the Status Page
post_idstringYesThe ID of the Status Page Post
query_modelStatusPagePostQueryNoOptional query parameters (e.g., include related resources)

list_status_page_post_updatesโ€‹

List updates for a specific status page post.

ParameterTypeRequiredDescription
status_page_idstringYesThe ID of the Status Page
post_idstringYesThe ID of the Status Page Post
query_modelStatusPagePostUpdateQueryNoOptional filtering parameters

create_status_page_post (write)โ€‹

Create a new post (incident or maintenance) on a status page. All posts require starts_at, ends_at, and at least one update.

ParameterTypeRequiredDescription
status_page_idstringYesThe ID of the Status Page
create_modelStatusPagePostCreateRequestWrapperYesThe post creation request

The create_model must include:

  • post.title โ€” The title of the post
  • post.post_type โ€” Either "incident" or "maintenance"
  • post.starts_at โ€” When the post becomes effective (ISO datetime, required)
  • post.ends_at โ€” When the post is concluded (ISO datetime, required)
  • post.updates โ€” List of at least one post update with message, status, severity, etc.
note

Requires --enable-write-tools flag.

Example prompt:

"Create a status page incident post on status page PXXXXXX titled 'API Degradation' starting now"


create_status_page_post_update (write)โ€‹

Add a new update to an existing status page post.

ParameterTypeRequiredDescription
status_page_idstringYesThe ID of the Status Page
post_idstringYesThe ID of the Status Page Post
create_modelStatusPagePostUpdateRequestWrapperYesThe post update creation request

The create_model must include:

  • post_update.message โ€” The message text for the update (required)
  • post_update.status โ€” Status reference (required)
  • post_update.severity โ€” Severity reference (required)
  • post_update.post โ€” Post reference (required)

Optional fields:

  • post_update.impacted_services โ€” List of impacted services (defaults to empty list)
  • post_update.notify_subscribers โ€” Whether to notify subscribers (defaults to false)
  • post_update.update_frequency_ms โ€” Update frequency in milliseconds (defaults to null)
note

Requires --enable-write-tools flag.