ConfigV1UpdateDropRuleBody

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/chronosphere/main/json-schema/chronosphere-config-v1-update-drop-rule-body-schema.json",
  "title": "ConfigV1UpdateDropRuleBody",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/chronosphere-droprule-api-openapi.yml#/components/schemas/ConfigV1UpdateDropRuleBody",
  "properties": {
    "create_if_missing": {
      "description": "If `true`, the DropRule will be created if it does not already exist, identified by `slug`. If `false`, an error will be returned if the DropRule does not already exist.",
      "type": "boolean"
    },
    "drop_rule": {
      "allOf": [
        {
          "$ref": "#/$defs/configv1DropRule"
        }
      ],
      "description": "The DropRule to update."
    },
    "dry_run": {
      "description": "If `true`, validates the specified configuration without creating or updating the DropRule. If the specified configuration is valid, the endpoint returns a partial response without the DropRule. If the specified configuration is invalid, the endpoint returns an error.",
      "type": "boolean"
    }
  },
  "type": "object",
  "$defs": {
    "DropRuleValueBasedDrop": {
      "properties": {
        "enabled": {
          "description": "Enables dropping metrics based on a set value.",
          "type": "boolean"
        },
        "target_drop_value": {
          "description": "The target data point value at which to drop metrics.",
          "format": "double",
          "type": "number"
        }
      },
      "type": "object"
    },
    "configv1DropRule": {
      "properties": {
        "created_at": {
          "description": "Timestamp of when the DropRule was created. Cannot be set by clients.",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "drop_nan_value": {
          "description": "Drops data points if values are Not a Number (NaN). If set to true, Chronosphere\ndrops NaN data points, along with any published staleness markers. See the\n[drop rules\ndocumentation](https://docs.chronosphere.io/control/shaping/shape-metrics/rules/drop-rules#define-a-value-based-drop-rule)\nfor more information.",
          "type": "boolean"
        },
        "filters": {
          "description": "Defines the conditions that determine whether to drop a metric. Drop rules can\nhave multiple filter conditions on different labels, making it possible to drop\na subset of the series matching a particular metric name.",
          "items": {
            "$ref": "#/$defs/configv1LabelFilter"
          },
          "type": "array"
        },
        "mode": {
          "allOf": [
            {
              "$ref": "#/$defs/configv1DropRuleMode"
            }
          ],
          "description": "If set to `DISABLED`, then the rule isn't applied when ingesting data points\nand metrics won't be dropped on the basis of this rule."
        },
        "name": {
          "description": "The name of the DropRule. You can modify this value after the DropRule is created.",
          "type": "string"
        },
        "slug": {
          "description": "The unique identifier of the DropRule. If a `slug` isn't provided, one is generated based on the `name` field. You can't modify this field after the DropRule is created.",
          "type": "string"
        },
        "updated_at": {
          "description": "Timestamp of when the DropRule was last updated. Cannot be set by clients.",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "value_based_drop": {
          "allOf": [
            {
              "$ref": "#/$defs/DropRuleValueBasedDrop"
            }
          ],
          "description": "Drops metrics based on values of `0` or `1`. This type of drop rule can\nsignificantly reduce data points per second, but changes metrics from continuous\nseries to sparse metrics. Adding a rule of this type can change the behavior of\nexisting monitors or dashboards that use the target metric."
        }
      },
      "required": [
        "name"
      ],
      "type": "object"
    },
    "configv1DropRuleMode": {
      "enum": [
        "ENABLED",
        "DISABLED",
        "PREVIEW"
      ],
      "type": "string"
    },
    "configv1LabelFilter": {
      "properties": {
        "name": {
          "description": "The name of the label to match.",
          "type": "string"
        },
        "value_glob": {
          "description": "The glob value of the label to match.",
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}