Skip to content
OpenStatus OpenStatus

Monitors

The monitors command is used to manage your monitors. You trigger, view and list your monitors using this command.

create (beta)

Section titled “create (beta)”

Create monitors

Terminal window
openstatus monitors create [options]

—access-token, -t="": OpenStatus API Access Token

—auto-accept, -y: Automatically accept the prompt

—config="": The configuration file containing monitor information (default: openstatus.yaml)

delete

Section titled “delete”

Delete a monitor

Terminal window
openstatus monitors delete [MonitorID] [options]

—access-token, -t="": OpenStatus API Access Token

—auto-accept, -y: Automatically accept the prompt

export

Section titled “export”

Export all your monitors

Terminal window
openstatus monitors export [options]

—access-token, -t="": OpenStatus API Access Token

—output, -o="": The output file name (default: openstatus.yaml)

info

Section titled “info”

Get a monitor information

Terminal window
openstatus monitors info [MonitorID] [options]

—access-token, -t="": OpenStatus API Access Token

list

Section titled “list”

List all monitors

Terminal window
openstatus monitors list [options]

—access-token, -t="": OpenStatus API Access Token

—all: List all monitors including inactive ones

trigger

Section titled “trigger”

Trigger a monitor execution

Terminal window
openstatus monitors trigger [MonitorId] [options]

—access-token, -t="": OpenStatus API Access Token