Post incidents
Tell the public what is happening. Posts are separate from your monitors' incidents, carry a series of updates, and move to the page's history when resolved.
The nrc monitor status-pages commands need CLI 0.23.0 or later.
A posted incident is what you tell the public: a title, an impact and a series of updates.
It is separate from your monitors' incidents. Those are internal: their summaries, error messages and targets are never published, and they don't post anything by themselves. A monitor's incident moves its component's status; a post is a person explaining it.
Everything you post is public. On a published page a post or an update is public within a minute. On an unpublished page only preview links show it, until you publish.
The page doesn't wait for a post. A component in trouble that no open post covers is still named under "Current problems".
Post an incident
nrc monitor status-pages incidents create acme \
--title "Elevated API errors" \
--status investigating \
--impact minor \
--message "We are looking into it." \
--component "API=partial_outage"Through the API: POST /status-pages/{id}/incidents.
| Field | Meaning |
|---|---|
title | Required, up to 200 characters. |
status | Required: investigating, identified, monitoring or resolved. |
impact | Required: none, minor, major or critical. |
body | The first update's text. Required, up to 5000 characters. It is plain text. |
startedAt | When it began. Defaults to now. It can't be in the future, and must be within the last 10 years. |
components | The components it affects, each with the status the page shows it in while the post is open: operational, degraded_performance, partial_outage or major_outage. |
monitorIncidentIds | The monitor incidents it is about, for your own navigation. These links are never published. |
While the post is open, the status it gives a component wins over what the component would show. A post that affects no component still counts towards the page's verdict.
Post an update
Each update has a status and a text, and its status becomes the post's. Updates can't be edited or removed.
nrc monitor status-pages incidents updates create acme <incident> \
--status monitoring \
--message "A fix is rolling out."Through the API: POST /status-pages/{id}/incidents/{incidentId}/updates, with
status and body. components, when you send it, replaces the affected
components.
Resolve it
An update with the status resolved ends the post. It stops affecting component
status and moves to the page's history, where it stays for the page's
historyDays.
A resolved post takes no more updates: the API answers 409 with the reason
INCIDENT_RESOLVED. If the problem comes back, post a new incident.
Correct a post
To fix a mistake without adding an update, correct the title, impact, start or references. This works on resolved posts too, and it doesn't move the status.
nrc monitor status-pages incidents update acme <incident> --title "Elevated API errors in Europe"Through the API: PATCH /status-pages/{id}/incidents/{incidentId}. Fields you
leave out stay as they are, and components replaces the list.
Where the public reads them
| Path | What it shows |
|---|---|
/ | The page, with its open posts and up to five posts resolved in the last seven days |
/incidents/<id> | One post with all its updates, open or in the history |
/history | Resolved posts within historyDays |
/feed.atom | Open and resolved posts |
How component status is decided
A component follows its monitor's confirmed incidents, shows no data when paused or not yet checked, and a posted incident's status wins while it is open.
Publish and preview
Make a page public, share a preview link that works for 15 minutes, change its address with a 30-day redirect, take it offline or delete it.