CLI Reference

Manage status pages, monitors, and incidents from the terminal.

Usage:

$ openstatus [GLOBAL FLAGS] [COMMAND] [COMMAND FLAGS] [ARGUMENTS...]

Global flags:

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:

$ openstatus [GLOBAL FLAGS] check [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

monitors command (aliases: m)

Manage your monitors.

Usage:

$ 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.

Usage:

$ openstatus [GLOBAL FLAGS] monitors apply [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

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.

Usage:

$ openstatus [GLOBAL FLAGS] monitors import [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

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:

$ openstatus [GLOBAL FLAGS] monitors info [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

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:

$ openstatus [GLOBAL FLAGS] monitors list [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

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:

$ openstatus [GLOBAL FLAGS] monitors logs [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

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:

$ openstatus [GLOBAL FLAGS] monitors log-info [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

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:

$ openstatus [GLOBAL FLAGS] monitors trigger [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

status-report command (aliases: sr)

Manage status reports.

Usage:

$ 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:

$ openstatus [GLOBAL FLAGS] status-report list [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

status-report info subcommand

Get status report details.

openstatus status-report info <ReportID> openstatus status-report info 12345

Usage:

$ openstatus [GLOBAL FLAGS] status-report info [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

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:

$ openstatus [GLOBAL FLAGS] status-report create [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

status-report update subcommand

Update status report metadata.

openstatus status-report update <ReportID> [--title "New title"] [--component-ids id1,id2]

Usage:

$ openstatus [GLOBAL FLAGS] status-report update [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

status-report delete subcommand

Delete a status report.

openstatus status-report delete <ReportID> openstatus status-report delete 12345 -y

Usage:

$ openstatus [GLOBAL FLAGS] status-report delete [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

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:

$ openstatus [GLOBAL FLAGS] status-report add-update [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

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:

$ 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:

$ openstatus [GLOBAL FLAGS] incident list [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

incident info subcommand

Get incident details and timeline.

openstatus incident info <IncidentID> openstatus inc info 42

Usage:

$ openstatus [GLOBAL FLAGS] incident info [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

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:

$ openstatus [GLOBAL FLAGS] incident declare [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

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:

$ openstatus [GLOBAL FLAGS] incident update [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

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:

$ openstatus [GLOBAL FLAGS] incident set-status [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

incident mitigate subcommand

Mark an incident as mitigated.

openstatus incident mitigate <IncidentID> [--note "..."] openstatus inc mitigate 42 --note "..."

Usage:

$ openstatus [GLOBAL FLAGS] incident mitigate [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

incident resolve subcommand

Mark an incident as resolved.

openstatus incident resolve <IncidentID> [--note "..."] openstatus inc resolve 42 --note "..."

Usage:

$ openstatus [GLOBAL FLAGS] incident resolve [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

incident reopen subcommand

Reopen a mitigated or resolved incident.

openstatus incident reopen <IncidentID> [--note "..."] openstatus inc reopen 42 --note "..."

Usage:

$ openstatus [GLOBAL FLAGS] incident reopen [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

incident cancel subcommand

Cancel an incident (closes it).

openstatus incident cancel <IncidentID> [--note "..."] openstatus inc cancel 42 --note "..."

Usage:

$ openstatus [GLOBAL FLAGS] incident cancel [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

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:

$ openstatus [GLOBAL FLAGS] incident note [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

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:

$ openstatus [GLOBAL FLAGS] incident link-report [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

incident unlink-report subcommand

Remove the link to an incident's status report.

openstatus incident unlink-report <IncidentID> openstatus inc unlink-report 42

Usage:

$ openstatus [GLOBAL FLAGS] incident unlink-report [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

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:

$ openstatus [GLOBAL FLAGS] incident close [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

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:

$ openstatus [GLOBAL FLAGS] incident delete [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

incident postmortem subcommand (aliases: pm)

Read, write and approve an incident's postmortem.

Usage:

$ 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:

$ openstatus [GLOBAL FLAGS] incident postmortem show [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

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:

$ openstatus [GLOBAL FLAGS] incident postmortem edit [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

incident postmortem approve subcommand

Approve the postmortem, optionally closing the incident.

openstatus incident postmortem approve <IncidentID> openstatus inc pm approve 42 --close -y

Usage:

$ openstatus [GLOBAL FLAGS] incident postmortem approve [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

maintenance command (aliases: mt)

Manage maintenance windows.

Usage:

$ openstatus [GLOBAL FLAGS] maintenance [ARGUMENTS...]

maintenance list subcommand

List all maintenance windows.

openstatus maintenance list openstatus maintenance list --page-id abc --limit 10

Usage:

$ openstatus [GLOBAL FLAGS] maintenance list [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

maintenance info subcommand

Get maintenance window details.

openstatus maintenance info <MaintenanceID> openstatus maintenance info 12345

Usage:

$ openstatus [GLOBAL FLAGS] maintenance info [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

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:

$ openstatus [GLOBAL FLAGS] maintenance create [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

maintenance update subcommand

Update a maintenance window.

openstatus maintenance update <MaintenanceID> [--title "New title"] [--message "New message"] [--from ...] [--to ...]

Usage:

$ openstatus [GLOBAL FLAGS] maintenance update [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

maintenance delete subcommand

Delete a maintenance window.

openstatus maintenance delete <MaintenanceID> openstatus maintenance delete 12345 -y

Usage:

$ openstatus [GLOBAL FLAGS] maintenance delete [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

status-page command (aliases: sp)

Manage status pages.

Usage:

$ 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:

$ openstatus [GLOBAL FLAGS] status-page list [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

status-page info subcommand

Get status page details.

openstatus status-page info <PageID> openstatus status-page info 12345

Usage:

$ openstatus [GLOBAL FLAGS] status-page info [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

notification command (aliases: n)

Manage notifications.

Usage:

$ openstatus [GLOBAL FLAGS] notification [ARGUMENTS...]

notification list subcommand

List all notifications.

openstatus notification list openstatus notification list --limit 10

Usage:

$ openstatus [GLOBAL FLAGS] notification list [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

notification info subcommand

Get notification details.

openstatus notification info <NotificationID> openstatus notification info 12345

Usage:

$ openstatus [GLOBAL FLAGS] notification info [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

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:

$ 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:

$ openstatus [GLOBAL FLAGS] private-locations list [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

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:

$ openstatus [GLOBAL FLAGS] private-locations info [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

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:

$ openstatus [GLOBAL FLAGS] private-locations create [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

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:

$ openstatus [GLOBAL FLAGS] run [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

whoami command (aliases: w)

Get your workspace information.

openstatus whoami

Get your current workspace information. Displays the workspace name, slug, and plan.

Usage:

$ openstatus [GLOBAL FLAGS] whoami [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported:

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:

$ openstatus [GLOBAL FLAGS] login [ARGUMENTS...]

logout command

Remove saved API token.

openstatus logout

Usage:

$ openstatus [GLOBAL FLAGS] logout [ARGUMENTS...]

terraform command (aliases: tf)

Generate Terraform configuration.

Usage:

$ openstatus [GLOBAL FLAGS] terraform [ARGUMENTS...]

terraform generate subcommand (aliases: gen)

Generate Terraform configuration from workspace resources.

openstatus terraform generate [--output-dir ./openstatus-terraform/]

Usage:

$ openstatus [GLOBAL FLAGS] terraform generate [COMMAND FLAGS] [ARGUMENTS...]

The following flags are supported: