CLI Reference
Complete reference for the statusas CLI — manage status pages, monitors, and incidents from your terminal.
Manage status pages, monitors, and incidents from the terminal.
Usage:
$ statusas [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 28 global regions.
statusas check
<URL>statusas check https://openstat.us statusas check https://openstat.us -X POST -H 'Authorization: Bearer …' -d '{"ping":true}' statusas check https://openstat.us -d @payload.json statusas check https://openstat.us --timing statusas check https://openstat.us --json | jq '.summary'
Run a one-shot HTTP check against a URL from 28 global regions. The check is executed by the public statusas 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:
$ statusas [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:
$ statusas [GLOBAL FLAGS] monitors [ARGUMENTS...]monitors apply subcommand
Create or update monitors.
statusas monitors apply statusas monitors apply --config custom.yaml -y statusas monitors apply --dry-run
Creates or updates monitors according to the statusas configuration file. Compares your statusas.yaml with the current state and applies changes.
Usage:
$ statusas [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 | "statusas.yaml" | none |
--access-token="…" (-t) | statusas 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 create subcommand
Create monitors.
statusas monitors create statusas monitors create --config custom.yaml -y
Create the monitors defined in the statusas.yaml file.
Usage:
$ statusas [GLOBAL FLAGS] monitors create [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--config="…" (-c) | The configuration file containing monitor information | string | "statusas.yaml" | none |
--access-token="…" (-t) | statusas API Access Token | string | OPENSTATUS_API_TOKEN | |
--auto-accept (-y) | Automatically accept the prompt | bool | false | none |
monitors delete subcommand
Delete a monitor.
statusas monitors delete
<MonitorID>statusas monitors delete 12345 -y
Usage:
$ statusas [GLOBAL FLAGS] monitors delete [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas API Access Token | string | OPENSTATUS_API_TOKEN | |
--auto-accept (-y) | Automatically accept the prompt | bool | false | none |
monitors import subcommand
Import all your monitors.
statusas monitors import statusas 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'.
Usage:
$ statusas [GLOBAL FLAGS] monitors import [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas API Access Token | string | OPENSTATUS_API_TOKEN | |
--output="…" (-o) | The output file name | string | "statusas.yaml" | none |
monitors info subcommand
Get a monitor information.
statusas monitors info
<MonitorID>statusas monitors info 12345 statusas monitors info 12345 --time-range 7d
Fetch the monitor information including configuration, live status per region, and summary metrics.
Usage:
$ statusas [GLOBAL FLAGS] monitors info [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas 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.
statusas monitors list statusas 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:
$ statusas [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) | statusas API Access Token | string | OPENSTATUS_API_TOKEN |
monitors logs subcommand
List HTTP response logs for a monitor.
statusas monitors logs
<MonitorID>statusas monitors logs 12345 statusas monitors logs 12345 --limit 10 statusas monitors logs 12345 --limit 5 --offset 5 statusas 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:
$ statusas [GLOBAL FLAGS] monitors logs [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas 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.
statusas monitors log-info
<MonitorID><LogID>statusas 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:
$ statusas [GLOBAL FLAGS] monitors log-info [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas API Access Token | string | OPENSTATUS_API_TOKEN |
monitors trigger subcommand
Trigger a monitor execution.
statusas monitors trigger
<MonitorID>statusas monitors trigger 12345
Trigger a monitor execution on demand. This command allows you to launch your tests on demand.
Usage:
$ statusas [GLOBAL FLAGS] monitors trigger [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas API Access Token | string | OPENSTATUS_API_TOKEN |
status-report command (aliases: sr)
Manage status reports.
Usage:
$ statusas [GLOBAL FLAGS] status-report [ARGUMENTS...]status-report list subcommand
List all status reports.
statusas status-report list statusas status-report list --status investigating --limit 10
Usage:
$ statusas [GLOBAL FLAGS] status-report list [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas 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.
statusas status-report info
<ReportID>statusas status-report info 12345
Usage:
$ statusas [GLOBAL FLAGS] status-report info [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas API Access Token | string | OPENSTATUS_API_TOKEN |
status-report create subcommand
Create a status report.
statusas status-report create --title "API Degradation" --status investigating --message "Investigating increased latency" --page-id 123
Usage:
$ statusas [GLOBAL FLAGS] status-report create [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas 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 |
status-report update subcommand
Update status report metadata.
statusas status-report update
<ReportID>[--title "New title"] [--component-ids id1,id2]
Usage:
$ statusas [GLOBAL FLAGS] status-report update [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas 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.
statusas status-report delete
<ReportID>statusas status-report delete 12345 -y
Usage:
$ statusas [GLOBAL FLAGS] status-report delete [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas 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.
statusas status-report add-update
<ReportID>--status resolved --message "Issue has been resolved"
Usage:
$ statusas [GLOBAL FLAGS] status-report add-update [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas 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 | |
--notify | Notify subscribers about this update | bool | false | none |
maintenance command (aliases: mt)
Manage maintenance windows.
Usage:
$ statusas [GLOBAL FLAGS] maintenance [ARGUMENTS...]maintenance list subcommand
List all maintenance windows.
statusas maintenance list statusas maintenance list --page-id abc --limit 10
Usage:
$ statusas [GLOBAL FLAGS] maintenance list [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas 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.
statusas maintenance info
<MaintenanceID>statusas maintenance info 12345
Usage:
$ statusas [GLOBAL FLAGS] maintenance info [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas API Access Token | string | OPENSTATUS_API_TOKEN |
maintenance create subcommand
Create a maintenance window.
statusas maintenance create --title "DB Migration" --message "Upgrading database" --from 2026-04-01T10:00:00Z --to 2026-04-01T12:00:00Z --page-id 123
Usage:
$ statusas [GLOBAL FLAGS] maintenance create [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas 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.
statusas maintenance update
<MaintenanceID>[--title "New title"] [--message "New message"] [--from ...] [--to ...]
Usage:
$ statusas [GLOBAL FLAGS] maintenance update [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas 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.
statusas maintenance delete
<MaintenanceID>statusas maintenance delete 12345 -y
Usage:
$ statusas [GLOBAL FLAGS] maintenance delete [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas 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:
$ statusas [GLOBAL FLAGS] status-page [ARGUMENTS...]status-page list subcommand
List all status pages.
statusas status-page list statusas status-page list --limit 10
Usage:
$ statusas [GLOBAL FLAGS] status-page list [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas 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.
statusas status-page info
<PageID>statusas status-page info 12345
Usage:
$ statusas [GLOBAL FLAGS] status-page info [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas API Access Token | string | OPENSTATUS_API_TOKEN |
notification command (aliases: n)
Manage notifications.
Usage:
$ statusas [GLOBAL FLAGS] notification [ARGUMENTS...]notification list subcommand
List all notifications.
statusas notification list statusas notification list --limit 10
Usage:
$ statusas [GLOBAL FLAGS] notification list [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas 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.
statusas notification info
<NotificationID>statusas notification info 12345
Usage:
$ statusas [GLOBAL FLAGS] notification info [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas 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 statusas monitors info and statusas check.
Usage:
$ statusas [GLOBAL FLAGS] private-locations [ARGUMENTS...]private-locations list subcommand
List all private locations.
statusas private-locations list statusas pl list statusas 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:
$ statusas [GLOBAL FLAGS] private-locations list [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas 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.
statusas private-locations info
<PrivateLocationID>statusas pl info pl_1a2b3c statusas 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:
$ statusas [GLOBAL FLAGS] private-locations info [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas 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.
statusas private-locations create --name office-paris statusas pl create --name office-paris --monitor-ids 12345,12346 statusas 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 statusas pl info --show-token. Run without --name in an interactive terminal to be prompted, including a picker for the monitors to attach.
Usage:
$ statusas [GLOBAL FLAGS] private-locations create [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas 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.
statusas run statusas run --config custom-config.yaml
Run the uptime tests defined in the config.statusas.yaml. The config file should be in the following format: tests: ids: - monitor-id-1 - monitor-id-2.
Usage:
$ statusas [GLOBAL FLAGS] run [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--config="…" | The configuration file | string | "config.statusas.yaml" | none |
--access-token="…" (-t) | statusas API Access Token | string | OPENSTATUS_API_TOKEN |
whoami command (aliases: w)
Get your workspace information.
statusas whoami
Get your current workspace information. Displays the workspace name, slug, and plan.
Usage:
$ statusas [GLOBAL FLAGS] whoami [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas API Access Token | string | OPENSTATUS_API_TOKEN |
login command
Save your API token.
statusas login
Saves your statusas API token for use in subsequent commands. Get your API token from the statusas dashboard.
Usage:
$ statusas [GLOBAL FLAGS] login [ARGUMENTS...]logout command
Remove saved API token.
statusas logout
Usage:
$ statusas [GLOBAL FLAGS] logout [ARGUMENTS...]terraform command (aliases: tf)
Generate Terraform configuration.
Usage:
$ statusas [GLOBAL FLAGS] terraform [ARGUMENTS...]terraform generate subcommand (aliases: gen)
Generate Terraform configuration from workspace resources.
statusas terraform generate [--output-dir ./statusas-terraform/]
Usage:
$ statusas [GLOBAL FLAGS] terraform generate [COMMAND FLAGS] [ARGUMENTS...]The following flags are supported:
| Name | Description | Type | Default value | Environment variables |
|---|---|---|---|---|
--access-token="…" (-t) | statusas API Access Token | string | OPENSTATUS_API_TOKEN | |
--output-dir="…" (-o) | Directory to write Terraform files into | string | "./statusas-terraform/" | none |
--force (-f) | Overwrite existing files in --output-dir | bool | false | none |