CLcloudzero
monitors

Update monitor

Changed on

Send only the fields you want to change; omitted fields keep their stored values. Only description accepts null, which clears it; null on any other field is a 422. System monitors accept only threshold and is_enabled. Returns 409 with error.existing_id if the change would give the monitor the same configuration as another.

patch/v2/monitors/{monitorId}

Request

Path parameters

monitorIdstring required

The ID of the monitor

Request body

cost_type'REAL_COST' | 'AMORTIZED_COST' | 'BILLED_COST' | 'CUSTOM_COST' | 'DISCOUNTED_AMORTIZED_COST' | 'DISCOUNTED_COST' | 'INVOICED_AMORTIZED_COST' | 'ON_DEMAND_COST'
descriptionstring nullable

Optional human-readable description for the monitor

detection_type'anomaly'

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

filter_setobject

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

group_bystring[]

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

is_enabledboolean

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

monitor_namestring

Human-readable name for the monitor

Response

Successful Response

cost_type'REAL_COST' | 'AMORTIZED_COST' | 'BILLED_COST' | 'CUSTOM_COST' | 'DISCOUNTED_AMORTIZED_COST' | 'DISCOUNTED_COST' | 'INVOICED_AMORTIZED_COST' | 'ON_DEMAND_COST'
created_atstring date-time required

When the monitor was created, as an ISO 8601 UTC timestamp

descriptionstring nullable

Optional human-readable description for the monitor

detection_type'anomaly'

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

filter_setobject

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

group_bystring[]

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

is_enabledboolean

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

last_triggered_atstring date-time nullable

When the monitor last raised an incident, as an ISO 8601 UTC timestamp; null until it first raises one.

monitor_idstring required

Unique identifier for the monitor

monitor_namestring required

Human-readable name for the monitor

open_incident_countinteger nullable

Number of unresolved incidents at read time; null if they could not be counted.

owner_idstring required

Email of the user who created the monitor; system for monitors CloudZero creates; Set via API for monitors created with an API key.

total_incident_countinteger

Total incidents this monitor has ever fired, including resolved ones.

updated_atstring date-time required

When the monitor was last updated, as an ISO 8601 UTC timestamp

Changes