Sign in

v2

latestOpenAPI 3.0.0SolarWinds Software Services Agreement2026-07-2167105153.0 KB
metrics

Update composite metric

Update a composite metric given a metric name.

put/v1/metrics/{name}

Path parameters

namestring required

Metric name.

Request body

displayNamestring nullable

Display name of the composite metric. A short description of the metric.

descriptionstring nullable

Description of the composite metric. A detailed description of the metric.

formulastring required

PromQL query to calculate the composite metric.

unitsstring nullable

Unit of the composite metric.

Example request

{
  "displayName": "Disk IO rate",
  "description": "Disk bytes transferred per second",
  "formula": "rate(system.disk.io[5m])",
  "units": "bytes/s"
}

Response

The request has succeeded.

namestring required

Name of the composite metric.

displayNamestring nullable

Display name of the composite metric. A short description of the metric.

descriptionstring nullable

Description of the composite metric. A detailed description of the metric.

formulastring required

PromQL query to calculate the composite metric.

unitsstring nullable

Unit of the composite metric.

Example response

{
  "name": "composite.custom.system.disk.io.rate",
  "displayName": "Disk IO rate",
  "description": "Disk bytes transferred per second",
  "formula": "rate(system.disk.io[5m])",
  "units": "bytes/s"
}