Something went wrong. Try again.
[READ-ONLY] Mirror of https://github.com/openstatusHQ/openstatus. 🫖 Status page with uptime monitoring & API monitoring as code 🫖 openstatus.dev
Something went wrong. Try again.
MDX
at main
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161---category: Referencetitle: CLI Referencedescription: Complete reference for the openstatus CLI — manage status pages, monitors, and incidents from your terminal.---
Manage status pages, monitors, and incidents from the terminal.
Usage:
```bash$ openstatus [GLOBAL FLAGS] [COMMAND] [COMMAND FLAGS] [ARGUMENTS...]```
Global flags:
| Name | Description | Type | Default value | Environment variables ||------------------|---------------------------|------|:-------------:|:---------------------:|| `--json` | Output results as JSON | bool | `false` | *none* || `--no-color` | Disable colored output | bool | `false` | *none* || `--quiet` (`-q`) | Suppress non-error output | bool | `false` | *none* || `--debug` | Enable debug output | bool | `false` | *none* |
## `check` command (aliases: `c`)
Run an HTTP check against a URL from 27 global regions.
> openstatus check `<URL>`> openstatus check https://openstat.us> openstatus check https://openstat.us -X POST -H 'Authorization: Bearer …' -d '\{"ping":true\}'> openstatus check https://openstat.us -d @payload.json> openstatus check https://openstat.us --timing> openstatus check https://openstat.us --json | jq '.summary'
Run a one-shot HTTP check against a URL from 27 global regions. The check is executed by the public openstatus speed checker. No API token is required. Results stream to the terminal as they arrive from each region. Output is sorted in the order regions report back (roughly fastest first). Pass `--timing` to see DNS/Connection/TLS/TTFB/Transfer phase breakdowns. Pass `--json` for a machine-readable single object including all phase data. Rate limits: 3 requests per 60 seconds and 10 requests per hour, both per IP.
Usage:
```bash$ openstatus [GLOBAL FLAGS] check [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------|----------------------------------------------------------|--------|:-------------:|:---------------------:|| `--method="…"` (`-X`) | HTTP method | string | `"GET"` | *none* || `--header="…"` (`-H`) | Header in "Key: Value" form (repeatable) | string | | *none* || `--body="…"` (`-d`) | Request body. Use @filename to read a file, @- for stdin | string | | *none* || `--timing` | Show DNS/Connection/TLS/TTFB/Transfer phases | bool | `false` | *none* |
## `monitors` command (aliases: `m`)
Manage your monitors.
Usage:
```bash$ openstatus [GLOBAL FLAGS] monitors [ARGUMENTS...]```
### `monitors apply` subcommand
Create or update monitors.
> openstatus monitors apply> openstatus monitors apply --config custom.yaml -y> openstatus monitors apply --dry-run
Creates or updates monitors according to the openstatus configuration file. Compares your openstatus.yaml with the current state and applies changes.
> **Deprecated:** prefer managing your monitors with Terraform via [`openstatus terraform generate`](#terraform-generate-subcommand-aliases-gen).
Usage:
```bash$ openstatus [GLOBAL FLAGS] monitors apply [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-------------------------------------------------------|--------|:-------------------:|:----------------------:|| `--config="…"` (`-c`) | The configuration file containing monitor information | string | `"openstatus.yaml"` | *none* || `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--auto-accept` (`-y`) | Automatically accept the prompt | bool | `false` | *none* || `--dry-run` (`-n`) | Show what would be changed without applying | bool | `false` | *none* |
### `monitors import` subcommand
Import all your monitors.
> openstatus monitors import> openstatus monitors import --output monitors.yaml
Import all your monitors from your workspace to a YAML file; it will also create a lock file to manage your monitors with `apply`.
> **Deprecated:** the monitors.yaml config file is deprecated for import. Prefer managing your monitors with Terraform via [`openstatus terraform generate`](#terraform-generate-subcommand-aliases-gen).
Usage:
```bash$ openstatus [GLOBAL FLAGS] monitors import [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-----------------------------|--------|:-------------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--output="…"` (`-o`) | The output file name | string | `"openstatus.yaml"` | *none* |
### `monitors info` subcommand
Get a monitor information.
> openstatus monitors info `<MonitorID>`> openstatus monitors info 12345> openstatus monitors info 12345 --time-range 7d
Fetch the monitor information including configuration, live status per region, and summary metrics.
Usage:
```bash$ openstatus [GLOBAL FLAGS] monitors info [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|----------------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--time-range="…"` | Time range for summary metrics (1d, 7d, 14d) | string | `"1d"` | *none* |
### `monitors list` subcommand
List all monitors.
> openstatus monitors list> openstatus monitors list --all
List all monitors. The list shows all your monitors attached to your workspace. It displays the ID, name, URL, and kind of each monitor.
Usage:
```bash$ openstatus [GLOBAL FLAGS] monitors list [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-------------------------------------------|--------|:-------------:|:----------------------:|| `--all` | List all monitors including inactive ones | bool | `false` | *none* || `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` |
### `monitors logs` subcommand
List HTTP response logs for a monitor.
> openstatus monitors logs `<MonitorID>`> openstatus monitors logs 12345> openstatus monitors logs 12345 --limit 10> openstatus monitors logs 12345 --limit 5 --offset 5> openstatus monitors logs 12345 --from 2026-05-06T00:00:00Z --to 2026-05-07T00:00:00Z
List HTTP response logs for a monitor from the 14-day retention window. Supports pagination and time filtering.
Usage:
```bash$ openstatus [GLOBAL FLAGS] monitors logs [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|------------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--limit="…"` | Maximum number of logs to return (1-100) | int | `0` | *none* || `--offset="…"` | Number of logs to skip for pagination | int | `0` | *none* || `--from="…"` | Start of time window (RFC 3339 format) | string | | *none* || `--to="…"` | End of time window (RFC 3339 format) | string | | *none* |
### `monitors log-info` subcommand
Get detailed HTTP response log for a monitor.
> openstatus monitors log-info `<MonitorID>` `<LogID>`> openstatus monitors log-info 12345 abc-def-ghi
Fetch a single HTTP response log with full details including timing phases, response headers, and assertion results.
Usage:
```bash$ openstatus [GLOBAL FLAGS] monitors log-info [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-----------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` |
### `monitors trigger` subcommand
Trigger a monitor execution.
> openstatus monitors trigger `<MonitorID>`> openstatus monitors trigger 12345
Trigger a monitor execution on demand. This command allows you to launch your tests on demand.
Usage:
```bash$ openstatus [GLOBAL FLAGS] monitors trigger [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-----------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` |
## `status-report` command (aliases: `sr`)
Manage status reports.
Usage:
```bash$ openstatus [GLOBAL FLAGS] status-report [ARGUMENTS...]```
### `status-report list` subcommand
List all status reports.
> openstatus status-report list> openstatus status-report list --status investigating --limit 10
Usage:
```bash$ openstatus [GLOBAL FLAGS] status-report list [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|--------------------------------------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--status="…"` | Filter by status (investigating, identified, monitoring, resolved) | string | | *none* || `--limit="…"` | Maximum number of reports to return (1-100) | int | `0` | *none* |
### `status-report info` subcommand
Get status report details.
> openstatus status-report info `<ReportID>`> openstatus status-report info 12345
Usage:
```bash$ openstatus [GLOBAL FLAGS] status-report info [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-----------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` |
### `status-report create` subcommand
Create a status report.
> openstatus status-report create --title "API Degradation" --status investigating --message "Investigating increased latency" --page-id 123
Usage:
```bash$ openstatus [GLOBAL FLAGS] status-report create [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|------------------------------------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--title="…"` | Title of the status report | string | | *none* || `--status="…"` | Initial status (investigating, identified, monitoring, resolved) | string | | *none* || `--message="…"` | Initial message describing the incident | string | | *none* || `--page-id="…"` | Status page ID to associate with this report | string | | *none* || `--component-ids="…"` | Comma-separated page component IDs (legacy; mutually exclusive with `--impact`) | string | | *none* || `--impact="…"` | Per-component impact, repeatable: `--impact <component_id>=<level>` (level: operational, degraded, partial_outage, major_outage). Mutually exclusive with `--component-ids` | string | | *none* || `--notify` | Notify subscribers about this status report | bool | `false` | *none* || `--date="…"` | Date when the event occurred (RFC 3339 format, defaults to now) | string | | *none* || `--incident-id="…"` | ID of an incident to link the report to | string | | *none* |
### `status-report update` subcommand
Update status report metadata.
> openstatus status-report update `<ReportID>` [--title "New title"] [--component-ids id1,id2]
Usage:
```bash$ openstatus [GLOBAL FLAGS] status-report update [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-------------------------------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--title="…"` | New title for the report | string | | *none* || `--component-ids="…"` | Comma-separated page component IDs (replaces existing list) | string | | *none* |
### `status-report delete` subcommand
Delete a status report.
> openstatus status-report delete `<ReportID>`> openstatus status-report delete 12345 -y
Usage:
```bash$ openstatus [GLOBAL FLAGS] status-report delete [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|---------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--auto-accept` (`-y`) | Automatically accept the prompt | bool | `false` | *none* |
### `status-report add-update` subcommand
Add an update to a status report.
> openstatus status-report add-update `<ReportID>` --status resolved --message "Issue has been resolved"
Usage:
```bash$ openstatus [GLOBAL FLAGS] status-report add-update [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|--------------------------------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--status="…"` | New status (investigating, identified, monitoring, resolved) | string | | *none* || `--message="…"` | Message describing what changed | string | | *none* || `--date="…"` | Date for the update (RFC 3339 format, defaults to now) | string | | *none* || `--impact="…"` | Per-component impact, repeatable: `--impact <component_id>=<level>` (level: operational, degraded, partial_outage, major_outage). Can also add new affected components | string | | *none* || `--notify` | Notify subscribers about this update | bool | `false` | *none* |
## `incident` command (aliases: `inc`, `incidents`)
Declare and run incidents.
Incidents are the internal response to an outage: severity, commander, lifecycle (open -> mitigated -> resolved, or canceled), timeline notes, a linked public status report and the postmortem. Use `openstatus status-report` for the public communication on a status page.
Usage:
```bash$ openstatus [GLOBAL FLAGS] incident [ARGUMENTS...]```
### `incident list` subcommand
List incidents.
> openstatus incident list> openstatus inc list --active> openstatus inc list --status open,mitigated --limit 10
Usage:
```bash$ openstatus [GLOBAL FLAGS] incident list [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-------------------------------------------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--status="…"` | Filter by status, comma-separated (open, mitigated, resolved, canceled) | string | | *none* || `--active` | Only incidents that are not closed | bool | `false` | *none* || `--closed` | Only closed incidents | bool | `false` | *none* || `--limit="…"` | Maximum number of incidents to return (1-100, defaults to 50) | int | `0` | *none* || `--offset="…"` | Number of incidents to skip | int | `0` | *none* |
### `incident info` subcommand
Get incident details and timeline.
> openstatus incident info `<IncidentID>`> openstatus inc info 42
Usage:
```bash$ openstatus [GLOBAL FLAGS] incident info [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-----------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` |
### `incident declare` subcommand (aliases: `create`)
Declare a new incident.
> openstatus incident declare --title "Checkout API returns 502" --severity major> openstatus inc declare --title "Database down" --severity critical --commander jane@example.com --slack> ID=$(openstatus inc declare --title "Login errors" --severity minor -q)
Declare a new incident in the open status. Run without --title or --severity in an interactive terminal to be prompted. In scripts, pass every required flag.
Usage:
```bash$ openstatus [GLOBAL FLAGS] incident declare [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|--------------------------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--title="…"` | Title of the incident (1-256 characters) | string | | *none* || `--severity="…"` | Severity of the incident (critical, major, minor) | string | | *none* || `--summary="…"` | Short human summary | string | | *none* || `--commander="…"` | Email of the workspace member leading the response | string | | *none* || `--started-at="…"` | When the impact began (RFC 3339, defaults to now) | string | | *none* || `--status-report-id="…"` | ID of an existing status report to link | string | | *none* || `--slack` | Open a dedicated Slack channel when Slack is connected | bool | `false` | *none* |
### `incident update` subcommand
Edit an incident's title, severity, summary, commander or start time.
> openstatus incident update `<IncidentID>` [flags]> openstatus inc update 42 --severity critical> openstatus inc update 42 --commander jane@example.com> openstatus inc update 42 --clear-summary
Usage:
```bash$ openstatus [GLOBAL FLAGS] incident update [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|---------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--title="…"` | New title (1-256 characters) | string | | *none* || `--severity="…"` | New severity (critical, major, minor) | string | | *none* || `--summary="…"` | New summary | string | | *none* || `--clear-summary` | Remove the summary | bool | `false` | *none* || `--commander="…"` | Email of the new commander | string | | *none* || `--clear-commander` | Unassign the commander | bool | `false` | *none* || `--started-at="…"` | New start of impact (RFC 3339) | string | | *none* |
### `incident set-status` subcommand
Move an incident to a new status.
> openstatus incident set-status `<IncidentID>` --status `<open|mitigated|resolved|canceled>` [--note "..."]> openstatus inc set-status 42 --status mitigated --note "Rolled back the deploy"
Allowed transitions: open -> mitigated, resolved or canceled; mitigated -> resolved, open or canceled; resolved -> open. Canceled is terminal and closes the incident. A linked status report is not updated: post the public update with `openstatus status-report add-update`.
Usage:
```bash$ openstatus [GLOBAL FLAGS] incident set-status [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-----------------------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--status="…"` | Target status (open, mitigated, resolved, canceled) | string | | *none* || `--note="…"` | Note recorded on the timeline with the change | string | | *none* || `--auto-accept` (`-y`) | Automatically accept the prompt | bool | `false` | *none* |
### `incident mitigate` subcommand
Mark an incident as mitigated.
> openstatus incident mitigate `<IncidentID>` [--note "..."]> openstatus inc mitigate 42 --note "..."
Usage:
```bash$ openstatus [GLOBAL FLAGS] incident mitigate [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-----------------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--note="…"` | Note recorded on the timeline with the change | string | | *none* |
### `incident resolve` subcommand
Mark an incident as resolved.
> openstatus incident resolve `<IncidentID>` [--note "..."]> openstatus inc resolve 42 --note "..."
Usage:
```bash$ openstatus [GLOBAL FLAGS] incident resolve [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-----------------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--note="…"` | Note recorded on the timeline with the change | string | | *none* |
### `incident reopen` subcommand
Reopen a mitigated or resolved incident.
> openstatus incident reopen `<IncidentID>` [--note "..."]> openstatus inc reopen 42 --note "..."
Usage:
```bash$ openstatus [GLOBAL FLAGS] incident reopen [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-----------------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--note="…"` | Note recorded on the timeline with the change | string | | *none* |
### `incident cancel` subcommand
Cancel an incident (closes it).
> openstatus incident cancel `<IncidentID>` [--note "..."]> openstatus inc cancel 42 --note "..."
Usage:
```bash$ openstatus [GLOBAL FLAGS] incident cancel [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-----------------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--note="…"` | Note recorded on the timeline with the change | string | | *none* || `--auto-accept` (`-y`) | Automatically accept the prompt | bool | `false` | *none* |
### `incident note` subcommand
Add a note to an incident timeline.
> openstatus incident note `<IncidentID>` --message "Rolled back the deploy"> echo "multi-line markdown" | openstatus inc note 42 --message -
Usage:
```bash$ openstatus [GLOBAL FLAGS] incident note [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|----------------------------------------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--message="…"` (`-m`) | Note text in markdown (1-10000 characters); use - to read from stdin | string | | *none* |
### `incident link-report` subcommand
Link a public status report to an incident.
> openstatus incident link-report `<IncidentID>` `<StatusReportID>`> openstatus inc link-report 42 123
Usage:
```bash$ openstatus [GLOBAL FLAGS] incident link-report [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-----------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` |
### `incident unlink-report` subcommand
Remove the link to an incident's status report.
> openstatus incident unlink-report `<IncidentID>`> openstatus inc unlink-report 42
Usage:
```bash$ openstatus [GLOBAL FLAGS] incident unlink-report [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-----------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` |
### `incident close` subcommand
Close a resolved incident.
> openstatus incident close `<IncidentID>`> openstatus inc close 42 --skip-postmortem -y
Close a resolved incident. A closed incident is read-only except for its postmortem. Requires an approved postmortem, or --skip-postmortem.
Usage:
```bash$ openstatus [GLOBAL FLAGS] incident close [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|--------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--skip-postmortem` | Close without an approved postmortem | bool | `false` | *none* || `--auto-accept` (`-y`) | Automatically accept the prompt | bool | `false` | *none* |
### `incident delete` subcommand
Delete an incident declared by mistake.
> openstatus incident delete `<IncidentID>`> openstatus inc delete 42 -y
Delete an incident declared by mistake. Only allowed while the incident is open and was never mitigated, resolved or closed; cancel it otherwise.
Usage:
```bash$ openstatus [GLOBAL FLAGS] incident delete [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|---------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--auto-accept` (`-y`) | Automatically accept the prompt | bool | `false` | *none* |
### `incident postmortem` subcommand (aliases: `pm`)
Read, write and approve an incident's postmortem.
Usage:
```bash$ openstatus [GLOBAL FLAGS] incident postmortem [ARGUMENTS...]```
### `incident postmortem show` subcommand
Show the postmortem of an incident.
> openstatus incident postmortem show `<IncidentID>`> openstatus inc pm show 42 > postmortem.md
In a terminal, prints the review status and the markdown body through your pager. When piped, prints only the markdown body, so it can be edited and sent back with `openstatus inc pm edit <ID> --file postmortem.md`.
Usage:
```bash$ openstatus [GLOBAL FLAGS] incident postmortem show [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-----------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` |
### `incident postmortem edit` subcommand
Write or replace the postmortem of a resolved incident.
> openstatus incident postmortem edit `<IncidentID>` --file postmortem.md> cat postmortem.md | openstatus inc pm edit 42 --file -> openstatus inc pm edit 42 --content "## Summary ..."
Replaces the whole markdown body. An approved postmortem stays approved.
Usage:
```bash$ openstatus [GLOBAL FLAGS] incident postmortem edit [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|---------------------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--file="…"` | Markdown file to upload; use - to read from stdin | string | | *none* || `--content="…"` | Markdown body passed inline | string | | *none* |
### `incident postmortem approve` subcommand
Approve the postmortem, optionally closing the incident.
> openstatus incident postmortem approve `<IncidentID>`> openstatus inc pm approve 42 --close -y
Usage:
```bash$ openstatus [GLOBAL FLAGS] incident postmortem approve [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|---------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--close` | Also close the incident | bool | `false` | *none* || `--auto-accept` (`-y`) | Automatically accept the prompt | bool | `false` | *none* |
## `maintenance` command (aliases: `mt`)
Manage maintenance windows.
Usage:
```bash$ openstatus [GLOBAL FLAGS] maintenance [ARGUMENTS...]```
### `maintenance list` subcommand
List all maintenance windows.
> openstatus maintenance list> openstatus maintenance list --page-id abc --limit 10
Usage:
```bash$ openstatus [GLOBAL FLAGS] maintenance list [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|--------------------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--page-id="…"` | Filter by status page ID | string | | *none* || `--limit="…"` | Maximum number of maintenances to return (1-100) | int | `0` | *none* |
### `maintenance info` subcommand
Get maintenance window details.
> openstatus maintenance info `<MaintenanceID>`> openstatus maintenance info 12345
Usage:
```bash$ openstatus [GLOBAL FLAGS] maintenance info [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-----------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` |
### `maintenance create` subcommand
Create a maintenance window.
> openstatus maintenance create --title "DB Migration" --message "Upgrading database" --from 2026-04-01T10:00:00Z --to 2026-04-01T12:00:00Z --page-id 123
Usage:
```bash$ openstatus [GLOBAL FLAGS] maintenance create [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|--------------------------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--title="…"` | Title of the maintenance | string | | *none* || `--message="…"` | Message describing the maintenance | string | | *none* || `--from="…"` | Start time of the maintenance window (RFC 3339 format) | string | | *none* || `--to="…"` | End time of the maintenance window (RFC 3339 format) | string | | *none* || `--page-id="…"` | Status page ID to associate with this maintenance | string | | *none* || `--component-ids="…"` | Comma-separated page component IDs | string | | *none* || `--notify` | Notify subscribers about this maintenance | bool | `false` | *none* |
### `maintenance update` subcommand
Update a maintenance window.
> openstatus maintenance update `<MaintenanceID>` [--title "New title"] [--message "New message"] [--from ...] [--to ...]
Usage:
```bash$ openstatus [GLOBAL FLAGS] maintenance update [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-------------------------------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--title="…"` | New title for the maintenance | string | | *none* || `--message="…"` | New message for the maintenance | string | | *none* || `--from="…"` | New start time (RFC 3339 format) | string | | *none* || `--to="…"` | New end time (RFC 3339 format) | string | | *none* || `--component-ids="…"` | Comma-separated page component IDs (replaces existing list) | string | | *none* |
### `maintenance delete` subcommand
Delete a maintenance window.
> openstatus maintenance delete `<MaintenanceID>`> openstatus maintenance delete 12345 -y
Usage:
```bash$ openstatus [GLOBAL FLAGS] maintenance delete [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|---------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--auto-accept` (`-y`) | Automatically accept the prompt | bool | `false` | *none* |
## `status-page` command (aliases: `sp`)
Manage status pages.
Usage:
```bash$ openstatus [GLOBAL FLAGS] status-page [ARGUMENTS...]```
### `status-page list` subcommand
List all status pages.
> openstatus status-page list> openstatus status-page list --limit 10
Usage:
```bash$ openstatus [GLOBAL FLAGS] status-page list [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-------------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--limit="…"` | Maximum number of pages to return (1-100) | int | `0` | *none* |
### `status-page info` subcommand
Get status page details.
> openstatus status-page info `<PageID>`> openstatus status-page info 12345
Usage:
```bash$ openstatus [GLOBAL FLAGS] status-page info [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-----------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` |
## `notification` command (aliases: `n`)
Manage notifications.
Usage:
```bash$ openstatus [GLOBAL FLAGS] notification [ARGUMENTS...]```
### `notification list` subcommand
List all notifications.
> openstatus notification list> openstatus notification list --limit 10
Usage:
```bash$ openstatus [GLOBAL FLAGS] notification list [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|---------------------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--limit="…"` | Maximum number of notifications to return (1-100) | int | `0` | *none* |
### `notification info` subcommand
Get notification details.
> openstatus notification info `<NotificationID>`> openstatus notification info 12345
Usage:
```bash$ openstatus [GLOBAL FLAGS] notification info [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-----------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` |
## `private-locations` command (aliases: `pl`)
Manage private locations.
Private locations are self-hosted checker agents that run monitors from inside your own network. This command lists them, shows their details, and creates new ones. Public regions (Fly.io, Koyeb, Railway) are not listed here; they appear in `openstatus monitors info` and `openstatus check`.
Usage:
```bash$ openstatus [GLOBAL FLAGS] private-locations [ARGUMENTS...]```
### `private-locations list` subcommand
List all private locations.
> openstatus private-locations list> openstatus pl list> openstatus pl list --limit 10
List the private locations in your workspace, with the health of each agent and the number of monitors it runs.
Usage:
```bash$ openstatus [GLOBAL FLAGS] private-locations list [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-------------------------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--limit="…"` | Maximum number of private locations to return (1-100) | int | `0` | *none* |
### `private-locations info` subcommand
Get private location details.
> openstatus private-locations info `<PrivateLocationID>`> openstatus pl info pl_1a2b3c> openstatus pl info pl_1a2b3c --show-token
Fetch a private location including the monitors it runs and its agent token. The token is masked unless `--show-token` is passed.
Usage:
```bash$ openstatus [GLOBAL FLAGS] private-locations info [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|----------------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--show-token` | Reveal the agent token instead of masking it | bool | `false` | *none* |
### `private-locations create` subcommand
Create a private location.
> openstatus private-locations create --name office-paris> openstatus pl create --name office-paris --monitor-ids 12345,12346> openstatus pl create --name office-paris --metadata env=prod --metadata team=infra
Create a private location and print its agent token. The token is shown in full because you need it to configure the agent; retrieve it later with `openstatus pl info --show-token`. Run without `--name` in an interactive terminal to be prompted, including a picker for the monitors to attach.
Usage:
```bash$ openstatus [GLOBAL FLAGS] private-locations create [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-------------------------------------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--name="…"` | Name of the private location | string | | *none* || `--monitor-ids="…"` | Monitor IDs to attach, comma-separated or repeated | string | | *none* || `--metadata="…"` | Key/value label, repeatable: --metadata `<key>=<value>` | string | | *none* |
## `run` command (aliases: `r`)
Run your uptime tests.
> openstatus run> openstatus run --config custom-config.yaml
Run the uptime tests defined in the config.openstatus.yaml. The config file should be in the following format: tests: ids: - monitor-id-1 - monitor-id-2.
Usage:
```bash$ openstatus [GLOBAL FLAGS] run [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-----------------------------|--------|:--------------------------:|:----------------------:|| `--config="…"` | The configuration file | string | `"config.openstatus.yaml"` | *none* || `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` |
## `whoami` command (aliases: `w`)
Get your workspace information.
> openstatus whoami
Get your current workspace information. Displays the workspace name, slug, and plan.
Usage:
```bash$ openstatus [GLOBAL FLAGS] whoami [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|-----------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` |
## `login` command
Save your API token.
> openstatus login
Saves your openstatus API token for use in subsequent commands. Get your API token from the openstatus dashboard.
Usage:
```bash$ openstatus [GLOBAL FLAGS] login [ARGUMENTS...]```
## `logout` command
Remove saved API token.
> openstatus logout
Usage:
```bash$ openstatus [GLOBAL FLAGS] logout [ARGUMENTS...]```
## `terraform` command (aliases: `tf`)
Generate Terraform configuration.
Usage:
```bash$ openstatus [GLOBAL FLAGS] terraform [ARGUMENTS...]```
### `terraform generate` subcommand (aliases: `gen`)
Generate Terraform configuration from workspace resources.
> openstatus terraform generate [--output-dir ./openstatus-terraform/]
Usage:
```bash$ openstatus [GLOBAL FLAGS] terraform generate [COMMAND FLAGS] [ARGUMENTS...]```
The following flags are supported:
| Name | Description | Type | Default value | Environment variables ||-----------------------------|------------------------------------------|--------|:---------------------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--output-dir="…"` (`-o`) | Directory to write Terraform files into | string | `"./openstatus-terraform/"` | *none* || `--force` (`-f`) | Overwrite existing files in --output-dir | bool | `false` | *none* |