Deployments.ai Docs
Command reference

deployments monitor

Monitors that email members and send webhook events when something needs attention

CommandSummary
deployments monitor listList monitors
deployments monitor createCreate a monitor
deployments monitor showShow a monitor
deployments monitor updateChange, mute, or unmute a monitor
deployments monitor archiveArchive a monitor
deployments monitor testSend a test alert to yourself and the monitor's webhooks
deployments monitor incidentsList alert incidents, newest first
deployments monitor incidentShow one alert incident with its timeline
deployments monitor notification-settingsShow your alert email settings
deployments monitor set-notification-settingsTurn your alert emails on or off, or mute monitors

deployments monitor list

List monitors.

deployments monitor list
  • Calls GET /v1/monitors (SDK listMonitors).
  • Needs an organization: --org or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size

Also accepts the global flags.

deployments monitor create

Create a monitor.

deployments monitor create --name <name> --condition <json> --notify <json>
  • Calls POST /v1/monitors (SDK createMonitor).
  • Needs an organization: --org or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
--namestringyesMonitor name
--conditionstring (json)yesCondition as JSON
--notifystring (json)yesWho to notify as JSON
--project-idstringProject of an environment monitor
--environment-idstringEnvironment the monitor watches
--renotify-minutesstring (number)Repeat the notification this often while firing

Also accepts the global flags.

deployments monitor show

Show a monitor.

deployments monitor show <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments monitor update

Change, mute, or unmute a monitor.

deployments monitor update <id>
  • Calls PATCH /v1/monitors/{id} (SDK updateMonitor).
  • Needs an organization: --org or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--namestringMonitor name
--conditionstring (json)Condition as JSON, e.g. {"kind":"run-failures","threshold":3,"windowMinutes":15}
--notifystring (json)Who to notify as JSON, e.g. {"emailRoles":["owner"],"emailPrincipalIds":[],"webhooks":true}
--mutestring (json)Mute as JSON: {} until unmuted, {"until":"<time>"}, or null to unmute
--renotify-minutesstring (number)Repeat the notification this often while firing

Also accepts the global flags.

deployments monitor archive

Archive a monitor.

deployments monitor archive <id>
  • Calls DELETE /v1/monitors/{id} (SDK archiveMonitor).
  • Needs an organization: --org or the saved context.
  • Destructive. Live runs ask for confirmation; pass --yes in scripts or with --json.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments monitor test

Send a test alert to yourself and the monitor's webhooks.

deployments monitor test <id>
  • Calls POST /v1/monitors/{id}/test (SDK testMonitor).
  • Needs an organization: --org or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments monitor incidents

List alert incidents, newest first.

deployments monitor incidents
  • Calls GET /v1/alert-incidents (SDK listAlertIncidents).
  • Needs an organization: --org or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size
--environment-idstringOnly this environment

Also accepts the global flags.

deployments monitor incident

Show one alert incident with its timeline.

deployments monitor incident <id> <incident-id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
<incident-id>positionalyesIncident ID

Also accepts the global flags.

deployments monitor notification-settings

Show your alert email settings.

deployments monitor notification-settings

Also accepts the global flags.

deployments monitor set-notification-settings

Turn your alert emails on or off, or mute monitors.

deployments monitor set-notification-settings --email <email> --muted-monitor-ids <json>
FlagTypeRequiredDefaultDescription
--emailstringyesall or none
--muted-monitor-idsstring (json)yesMonitor IDs to mute as a JSON array

Also accepts the global flags.

On this page