Sign in
Metric

Update a metric

Update properties of a metric. The metric's name and metric values cannot be updated.

Permissions

This endpoint requires the following permissions:

  • Metric:ModifyMetric for the metric to modify.
post/v1/{organization}/metric/{metric_id}/

Path parameters

organizationstring required
metric_idstring required

The ID of the metric to update.

The ID of the metric to update.

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Request body

applied_to_servicesstring[] nullable

The services that the metric is applied to. Only updated if set.

tagsobject nullable

The tags of the metric. Only updated if set.

Response

Succeeded

{"stackTrail":"paths:/v1/{organization}/metric/{metric_id}/:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}