Sign in

v1

latestOpenAPI 3.0.12026-07-13149396412.1 KB
DerivedLabel

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

Path parameters

slugstring required

Request body

create_if_missingboolean

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

dry_runboolean

If true, the DerivedLabel isn't created or updated, and no response DerivedLabel will be returned. The response will return an error if the given DerivedLabel is invalid.

Example request

{
  "derived_label": {
    "metric_label": {
      "constructed_label": {
        "value_definitions": [
          {
            "filters": [
              {
                "name": "job",
                "value_glob": "myservice*"
              }
            ]
          }
        ]
      },
      "mapping_label": {
        "name_mappings": [
          {
            "filters": [
              {
                "name": "job",
                "value_glob": "myservice*"
              }
            ]
          }
        ]
      }
    }
  }
}

Response

A successful response containing the updated DerivedLabel.

Example response

{
  "derived_label": {
    "metric_label": {
      "constructed_label": {
        "value_definitions": [
          {
            "filters": [
              {
                "name": "job",
                "value_glob": "myservice*"
              }
            ]
          }
        ]
      },
      "mapping_label": {
        "name_mappings": [
          {
            "filters": [
              {
                "name": "job",
                "value_glob": "myservice*"
              }
            ]
          }
        ]
      }
    }
  }
}