Metrics

Update an existing monitoring alert rule for an external service.

put/external-services/{id}/metrics/alert-rules/{rule_id}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/external-services/{id}/metrics/alert-rules/{rule_id}
  • Auth: HTTP bearer

Path parameters

idinteger required

External service ID

rule_idinteger required

Alert rule ID

Request body

comparatorstring nullable
enabledboolean nullable
for_duration_secsinteger nullable
metric_namestring nullable
namestring nullable
severitystring nullable
thresholdnumber double nullable

Response

Updated alert rule

comparatorstring required
deployment_idinteger nullable
enabledboolean required
for_duration_secsinteger required
idinteger required
metric_namestring required
namestring required
node_idinteger nullable

Node the rule is scoped to. 0 is the synthetic control-plane node (see CONTROL_PLANE_NODE_ID), which owns the proxy.* and node.* rules. Exactly one of service_id/deployment_id/node_id is set.

service_idinteger nullable
severitystring required
silenced_untilstring nullable
thresholdnumber double required

Changes

No recorded changes to this operation across all 53 revisions of this API.