Incident commands: acknowledge, open, resolve
The Incident Verbs acknowledge, open, resolve as CLI commands, with inputs, result, refusals and an example.
Reference for Incident, one group of Incident commands.
Incident.acknowledge
Acknowledge records that an on-call Worker owns an open Incident and stops its escalation. Verb page.
npx startup-builder do Incident.acknowledge --json '<input>' [--try | --send | --do]Emits Incident.acknowledged.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
incident | Incident | required | The open Incident. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
incident | Incident | required | The acknowledged Incident. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
npx startup-builder do Incident.acknowledge --json '{"incident": "incident_2XOYkIEno0"}'Incident.open
Open starts an Incident from a failing Monitor, an error spike or a Metric past its threshold, and pages the on-call Worker. Verb page.
npx startup-builder do Incident.open --json '<input>' [--try | --send | --do]Emits Incident.opened.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
severity | string | required | sev1 stops Customers, sev2 degrades a core path, sev3 degrades one feature. |
cause | string | required | The Monitor, error group or Metric that tripped it. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
incident | Incident | required | The open Incident. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
npx startup-builder do Incident.open --json '{"severity": "sev1", "cause": "Example cause"}'Incident.resolve
Resolve closes an Incident once its Monitors pass, posts the resolution to the status page and opens the review Task. Verb page.
npx startup-builder do Incident.resolve --json '<input>' [--try | --send | --do]Emits Incident.resolved.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
incident | Incident | required | The Incident to close. |
summary | text | required | What failed and what fixed it. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
incident | Incident | required | The resolved Incident. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
npx startup-builder do Incident.resolve --json '{"incident": "incident_2XOYkIEno0", "summary": "Example summary"}'