v51

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01206322659.2 KB
alarms

Rename or enable/disable a custom metric definition

Only the name and the enabled flag are mutable. The predicate and destination metric are fixed at creation: changing them would splice two different meanings into one series with nothing marking the seam, so a changed definition should be a new definition.

Disabling stops new observations within one flush interval (~10s). Bins already written stay and age out with normal metric retention.

The owning project is not mutable either, so the permission needed here is fixed: alarms.manage for an org-wide definition, projects.alarms.manage on the owner for a project one.

patch/orgs/{org_id}/metrics/definitions/{definition_id}

Path parameters

org_idstring required
definition_idstring required

Request body

enabledboolean nullable
namestring nullable

Response

Definition updated

{"stackTrail":"paths:/orgs/{org_id}/metrics/definitions/{definition_id}:patch:responses:204:content:application/json:schema","oasType":"schema","type":"unknown","description":"Successful responses use HTTP 204 and do not include a body."}