Справочник команд – Документация Status200

Полное описание команд Status200 CLI.

Команды аутентификации

`status200 login`

Вход в инстанс Status200.

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

Параметр	Тип	Обязательный	Описание
`<api-key>`	аргумент	Да	API key
`<instance-url>`	аргумент	Да	URL инстанса Status200
`--context-name`	опция	Нет	Имя контекста (по умолчанию: `"default"`)

`status200 context list`

Список сохранённых контекстов.

status200 context list

`status200 context use`

Активировать именованный контекст.

status200 context use <name>

Параметр	Тип	Обязательный	Описание
`<name>`	аргумент	Да	Имя контекста

`status200 context current`

Текущий контекст и замаскированный API key.

status200 context current

`status200 context delete`

Удалить сохранённый контекст.

status200 context delete <name>

Параметр	Тип	Обязательный	Описание
`<name>`	аргумент	Да	Имя контекста для удаления

Команды ресурсов

Все команды ресурсов следуют одному шаблону. Вместо <resource> подставьте имя ресурса (например, incident, monitor, alert, status-page).

`status200 <resource> list`

Список ресурсов с фильтрацией и пагинацией.

status200 <resource> list [options]

Опция	Тип	По умолчанию	Описание
`--query <json>`	строка	Нет	Критерии фильтра в JSON
`--limit <n>`	число	`10`	Максимум записей
`--skip <n>`	число	`0`	Пропуск записей
`--sort <json>`	строка	Нет	Сортировка в JSON
`-o, --output`	строка	`table`	Формат вывода

`status200 <resource> get`

Один ресурс по ID.

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

Параметр	Тип	Обязательный	Описание
`<id>`	аргумент	Да	ID ресурса (UUID)
`-o, --output`	опция	Нет	Формат вывода

`status200 <resource> create`

Создание ресурса.

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

Опция	Тип	Обязательность	Описание
`--data <json>`	строка	Одно из `--data` или `--file`	Данные ресурса в JSON
`--file <path>`	строка	Одно из `--data` или `--file`	Путь к JSON-файлу
`-o, --output`	строка	Нет	Формат вывода

`status200 <resource> update`

Обновление ресурса.

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

Параметр	Тип	Обязательный	Описание
`<id>`	аргумент	Да	ID ресурса
`--data <json>`	опция	Да	Поля для обновления в JSON
`-o, --output`	опция	Нет	Формат вывода

`status200 <resource> delete`

Удаление ресурса.

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

Параметр	Тип	Обязательный	Описание
`<id>`	аргумент	Да	ID ресурса
`--force`	опция	Нет	Без запроса подтверждения

`status200 <resource> count`

Подсчёт ресурсов по фильтру.

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

Опция	Тип	По умолчанию	Описание
`--query <json>`	строка	Нет	Критерии фильтра в JSON

Служебные команды

`status200 version`

Версия CLI.

status200 version

`status200 whoami`

Текущие параметры аутентификации.

status200 whoami

URL инстанса и замаскированный API key; при активном сохранённом контексте — его имя.

`status200 resources`

Доступные типы ресурсов.

status200 resources [--type <type>]

Опция	Тип	По умолчанию	Описание
`--type <type>`	строка	Нет	Фильтр: `database` или `analytics`

Глобальные опции

Доступны для всех команд:

Опция	Описание
`--api-key <key>`	Переопределить API key
`--url <url>`	Переопределить URL инстанса
`--context <name>`	Использовать контекст
`-o, --output <format>`	Формат: `json`, `table`, `wide`
`--no-color`	Без цвета
`--help`	Справка
`--version`	Версия

API routes

Для справки: соответствие команд эндпоинтам API:

Команда	Метод	Endpoint
`list`	POST	`/api/<resource>/get-list`
`get`	POST	`/api/<resource>/<id>/get-item`
`create`	POST	`/api/<resource>`
`update`	PUT	`/api/<resource>/<id>/`
`delete`	DELETE	`/api/<resource>/<id>/`
`count`	POST	`/api/<resource>/count`

Во всех запросах для аутентификации передаётся заголовок APIKey.