Update monitor

Send only the fields you want to change; omitted fields keep their stored values. For example, {"is_enabled": false} pauses a monitor and leaves everything else as is. Only description accepts null, which clears it; null on any other field returns 422. group_by accepts at most one Dimension. System monitors accept only threshold and is_enabled. For what each cost_type value measures, see Cost Types.
Returns 404 if the monitor does not exist or belongs to another organization. Returns 409 if the change would give the monitor the same filter_set, group_by, threshold, and cost_type as another monitor; error.existing_id names that monitor. Paused monitors count as a match and deleted monitors don't. A change to only monitor_name, description, or is_enabled never returns 409.
CloudZero records the change in the activity log, attributed to "Set via API", after saving it. If that log write fails, the update still applies.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the monitor

Body Params

Fields to change on a monitor. Fields left out keep their stored values; only description
accepts null (to clear it), so every other field is either a value or left out.

string
enum

The type of cost to monitor.

length ≤ 1000

Optional human-readable description for the monitor

const
enum

The type of detection to perform. Currently only "anomaly" is supported.

Allowed:
filter_set
object

Cost filters for the monitor. An empty object is valid.

group_by
array of strings
length ≤ 1

Dimensions to group by. Empty means no grouping; create/update requests are capped to a single dimension.

Group By
boolean

Whether the monitor is running. When false the monitor will not be sent for evaluation.

string
length between 1 and 255

Human-readable name for the monitor

threshold
object

Optional significance threshold: an anomaly is surfaced as an incident only if its cost impact
meets it. Leave both min_cost_impact and percentage unset to surface every anomaly.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json