Skip to main content

Statuspage

@hmcrum/statuspagev2026.09.17.1· 19d agoMODELS
01README

Manage an Atlassian Statuspage from swamp — component and incident model types wrapping the Statuspage REST API v1. Full CRUD lifecycle plus drift-detecting sync, idempotent create/delete, and rate-limit-aware retries.

02Models2
@hmcrum/statuspage-componentv2026.09.17.1statuspage_component.ts

Global Arguments

ArgumentTypeDescription
pageIdstringStatuspage page identifier
apiKeystringStatuspage API key (Authorization: OAuth <key>)
namestringComponent display name
descriptionstringComponent description
groupId?stringOptional component group id to nest this component under
showcasebooleanWhether to show uptime showcase for the component
fn create()
Create the component (idempotent — reuses existing state)
fn update()
Update component attributes and status
fn delete()
Delete the component from the status page
fn sync()
Refresh stored component state from the live API

Resources

component(infinite)— Statuspage component state
@hmcrum/statuspage-incidentv2026.09.17.1statuspage_incident.ts

Global Arguments

ArgumentTypeDescription
pageIdstringStatuspage page identifier
apiKeystringStatuspage API key (Authorization: OAuth <key>)
namestringIncident title
bodystringIncident update body posted with create/update
componentIdsarrayComponent ids affected by this incident
deliverNotificationsbooleanWhether subscribers are notified on updates
fn create()
Open a new incident (idempotent — reuses existing state)
fn update()
Post an incident update with the current status and body
fn resolve(body: string)
Resolve the incident by posting a resolving update
ArgumentTypeDescription
bodystringResolution message posted as the final incident update
fn delete()
Delete the incident from the status page
fn sync()
Refresh stored incident state from the live API

Resources

incident(infinite)— Statuspage incident state
03Stats
B
85 / 100
Downloads
14
Archive size
12.5 KB
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License declared1/1earned
  • Verified public repository0/2missing
04Platforms
05Labels