Command Reference

View as Markdown

Every command of the status200 CLI, with its arguments, options and defaults. Add --help to any command to see the same in your terminal.

Global optionsThe options every command takes.Login and contextslogin and the context commands.Resource commandslist, get, create, update, delete and count.Other commandsdeploy, whoami, resources, version and help.

The commands

flowchart LR O["status200"] --> L["login"] O --> C["context"] C --> C1["list use current delete"] O --> R["incident, monitor and every resource"] R --> R1["list get create update delete count"] O --> U["deploy whoami resources version help"]

The commands of the status200 CLI

Global options

Option	What it does	Default
`--api-key <key>`	The API key for this command	`STATUS200_API_KEY`, then the context's key
`--url <url>`	Your Status200's address for this command	`STATUS200_URL`, then the context's URL
`--context <name>`	The saved context to use for this command	The current context
`-o, --output <format>`	`json`, `table` or `wide`	`table` in a terminal, `json` in a pipe
`--no-color`	Prints without colors	Colors, unless `NO_COLOR` is set
`-V, --version`	Prints the CLI's version
`-h, --help`	Shows the help of a command

The options go before or after the command: status200 --context staging incident list and status200 incident list --context staging do the same.

Saves an API key and an address as a context, and makes it the current one. See Log in.

Bash

status200 login <api-key> <instance-url> [--context-name <name>]

Argument or option	Required	What it is	Default
`<api-key>`	Yes	An API key of your project
`<instance-url>`	Yes	Your Status200's address, such as `https://status200.ru`
`--context-name <name>`	No	The name to save the context under	`default`

`status200 context list`

Lists the saved contexts; * marks the current one. API keys are never listed.

Bash

status200 context list [-o <format>]

Option	Required	What it is
`-o, --output <format>`	No	`json`, `table` or `wide`. JSON gives each context's `name`, `apiUrl` and `isCurrent`

`status200 context use`

Makes a saved context the current one.

Bash

status200 context use <name>

Argument	Required	What it is
`<name>`	Yes	The name of a saved context

`status200 context current`

Shows the current context's name and URL, and its API key with all but the first four and last four characters hidden.

Bash

status200 context current

`status200 context delete`

Deletes a saved context. If it was the current one, the first context left becomes current.

Bash

status200 context delete <name>

Argument	Required	What it is
`<name>`	Yes	The name of a saved context

Resource commands

<resource> is the command of a kind of record, from the Resources tables, such as incident or monitor. See Resource Operations for examples.

`status200 <resource> list`

Lists records, newest first. Labels are listed by name instead, numbered labels first (2. Team before 10. Owner).

Bash

status200 <resource> list [--query <json>] [--limit <n>] [--skip <n>] [--sort <json>] [-o <format>]

Option	What it does	Default
`--query <json>`	A filter, as JSON	Every record the key may read
`--limit <n>`	The most records to return, up to 10,000	`10`
`--skip <n>`	How many records to pass over first	`0`
`--sort <json>`	The order, as JSON: `{"<field>":"ASC"}` or `{"<field>":"DESC"}`	Newest first
`-o, --output <format>`	`json`, `table` or `wide`	`table` in a terminal, `json` in a pipe

`status200 <resource> get`

Reads one record. Records only: telemetry has no get.

Bash

status200 <resource> get <id> [-o <format>]

Argument or option	Required	What it is
`<id>`	Yes	The record's ID, a UUID
`-o, --output <format>`	No	`json`, `table` or `wide`

`status200 <resource> create`

Creates a record and prints it.

Bash

status200 <resource> create (--data <json> | --file <path>) [-o <format>]

Option	Required	What it is
`--data <json>`	One of the two	The record, as JSON
`--file <path>`	One of the two	A JSON file holding the record. Given with `--data`, the file is used
`-o, --output <format>`	No	`json`, `table` or `wide`

`status200 <resource> update`

Changes the fields you give. Records only: telemetry has no update.

Bash

status200 <resource> update <id> --data <json> [-o <format>]

Argument or option	Required	What it is
`<id>`	Yes	The record's ID
`--data <json>`	Yes	The fields to change, as JSON
`-o, --output <format>`	No	`json`, `table` or `wide`

`status200 <resource> delete`

Deletes a record at once, without asking. Records only: telemetry has no delete.

Bash

status200 <resource> delete <id> [--force]

Argument or option	Required	What it is
`<id>`	Yes	The record's ID
`--force`	No	Accepted and changes nothing: `delete` never asks to confirm

`status200 <resource> count`

Counts records, and prints the number.

Bash

status200 <resource> count [--query <json>] [-o <format>]

Option	Required	What it is
`--query <json>`	No	A filter, as JSON. Without one, every record the key may read
`-o, --output <format>`	No	`json`, `table` or `wide`

Resources

Records take list, get, create, update, delete and count:

Area	Commands
Monitoring	`monitor`, `monitor-status`, `monitor-status-event`
Incidents	`incident`, `incident-state`, `incident-severity`, `incident-state-timeline`, `incident-public-note`, `incident-internal-note`, `incident-alert`, `postmortem-status`
Alerts	`alert`, `alert-state`, `alert-severity`, `alert-state-timeline`, `alert-internal-note`
Status pages	`status-page`, `status-page-announcement`
Scheduled maintenance	`scheduled-maintenance-event`, `scheduled-maintenance-state`, `scheduled-maintenance-state-timeline`
Teams and on-call	`team`, `on-call-policy`
Security	`security-case`, `security-case-note`, `security-detection`, `security-playbook`
Labels	`label`

Telemetry takes list, create and count:

Area	Commands
Observability	`log`, `metric`, `span`, `exception-instance`, `monitor-log`
Security	`security-event`, `threat-intel-indicator`
Changes and cost	`change-event`, `kubernetes-cost-allocation`

The CLI is released with Status200, so status200 resources lists the commands of the version you installed.

API requests

Each operation is one request to the API, with the key in the APIKey header. <path> is the resource's API path, from status200 resources: /incident for incident, /on-call-duty-policy for on-call-policy.

Operation	Request	Body
`list`	`POST /api/<path>/get-list`	`query`, `select`, `skip`, `limit` and `sort`
`get`	`POST /api/<path>/<id>/get-item`	`select`
`create`	`POST /api/<path>`	`{"data": ...}`
`update`	`PUT /api/<path>/<id>/`	`{"data": ...}`
`delete`	`DELETE /api/<path>/<id>/`	None
`count`	`POST /api/<path>/count`	`query`

Other commands

`status200 deploy`

Records a deploy, or another change, from a pipeline: it is drawn on the service's charts and read by Status200 AI when it investigates an incident. It writes with a telemetry ingestion key, not an API key. See Deploys and changes.

Bash

status200 deploy [--service <name>] [--service-version <version>] [--previous-version <version>] [--commit <sha>] [--repository <url>] [--branch <name>] [--pull-request <number>] [--environment <name>] [--title <title>] [--description <text>] [--type <type>] [--time <time>] [--attribute <key=value...>] [--ingestion-key <key>]

Option	Required	What it is	Default
`--service <name>`	No	The service that was deployed	A project-wide change
`--service-version <version>`	No	The version deployed
`--previous-version <version>`	No	The version it replaced
`--commit <sha>`	No	The commit deployed
`--repository <url>`	No	The repository the commit is in
`--branch <name>`	No	The branch deployed
`--pull-request <number>`	No	The pull request deployed
`--environment <name>`	No	The environment deployed to
`--title <title>`	No	The change's title; another kind than a deploy needs one	`Deploy <version>`
`--description <text>`	No	Details of the change
`--type <type>`	No	The kind of change, such as `config-change` or `rollback`	`deployment`
`--time <time>`	No	When it happened, such as `2026-10-19T10:00:00Z`	Now
`--attribute <key=value...>`	No	More attributes, as `key=value`, one or more
`--ingestion-key <key>`	No	A telemetry ingestion key of the project	`STATUS200_TELEMETRY_INGESTION_KEY`

`status200 whoami`

Shows the URL and the API key the next command will use, with the key masked, and the context they come from. It does not call Status200. See Check what the CLI will use.

Bash

status200 whoami

`status200 resources`

Lists every kind of record the CLI has a command for: its command, singular and plural names, type and API path, and the total.

Bash

status200 resources [--type <type>] [-o <format>]

Option	Required	What it is	Default
`--type <type>`	No	`database` for records, `analytics` for telemetry	Both
`-o, --output <format>`	No	`json`, `table` or `wide`. JSON gives each one's `name`, `singularName`, `pluralName`, `modelType` and `apiPath`	`table` in a terminal, `json` in a pipe

`status200 version`

Prints the CLI's version, as status200 --version does.

Bash

status200 version

`status200 help`

Shows the help of the CLI, or of a command.

Bash

status200 help [command]

Environment variables

Variable	What it does
`STATUS200_API_KEY`	The API key, when no `--api-key` flag gives one
`STATUS200_URL`	Your Status200's address, when no `--url` flag gives one
`STATUS200_TELEMETRY_INGESTION_KEY`	The telemetry ingestion key `status200 deploy` writes with, when no `--ingestion-key` flag gives one
`NO_COLOR`	Set to any value, turns colors off

Files

File	What it holds
`~/.oneuptime/config.json`	The saved contexts, their API keys, and the current context

Exit codes

Code	Meaning
`0`	It worked
`1`	It failed: Status200 refused the request, or the command was wrong
`2`	No usable API key: none found, invalid, or below its plan
`3`	Not found: Status200 answered `404`

See Exit codes for examples.

Next steps

CLI OverviewInstall the CLI and run your first commands.Resource OperationsExamples of every operation.Scripting & CI/CDThe CLI in scripts and pipelines.

The commands#

Global options#

Login and contexts#

status200 login#

status200 context list#

status200 context use#

status200 context current#

status200 context delete#

Resource commands#

status200 <resource> list#

status200 <resource> get#

status200 <resource> create#

status200 <resource> update#

status200 <resource> delete#

status200 <resource> count#

Resources#

API requests#

Other commands#

status200 deploy#

status200 whoami#

status200 resources#

status200 version#

status200 help#

Environment variables#

Files#

Exit codes#

Next steps#

The commands

Global options

Login and contexts

`status200 login`

`status200 context list`

`status200 context use`

`status200 context current`

`status200 context delete`

Resource commands

`status200 <resource> list`

`status200 <resource> get`

`status200 <resource> create`

`status200 <resource> update`

`status200 <resource> delete`

`status200 <resource> count`

Resources

API requests

Other commands

`status200 deploy`

`status200 whoami`

`status200 resources`

`status200 version`

`status200 help`

Environment variables

Files

Exit codes

Next steps