Sign in

v1

latestOpenAPI 3.0.32026-07-26191565482.4 KB
DerivedMetric

put/api/v1/config/derived-metrics/{slug}

Path parameters

slugstring required

Request body

create_if_missingboolean

If true, the DerivedMetric will be created if it does not already exist, identified by slug. If false, an error will be returned if the DerivedMetric does not already exist.

dry_runboolean

If true, validates the specified configuration without creating or updating the DerivedMetric. If the specified configuration is valid, the endpoint returns a partial response without the DerivedMetric. If the specified configuration is invalid, the endpoint returns an error.

Example request

{
  "derived_metric": {
    "metric_name": "cpu_usage:instance",
    "queries": [
      {
        "query": {
          "prometheus_expr": "cpu_usage{$service, $instance} / sum(cpu_usage{$service})",
          "variables": [
            {
              "default_prometheus_selector": "service=~\".*\"",
              "name": "service"
            }
          ]
        }
      }
    ]
  }
}

Response

A successful response containing the updated DerivedMetric.

Example response

{
  "derived_metric": {
    "metric_name": "cpu_usage:instance",
    "queries": [
      {
        "query": {
          "prometheus_expr": "cpu_usage{$service, $instance} / sum(cpu_usage{$service})",
          "variables": [
            {
              "default_prometheus_selector": "service=~\".*\"",
              "name": "service"
            }
          ]
        }
      }
    ]
  }
}