---
title: "PUT /api/v1/config/drop-rules/{slug}"
method: PUT
path: "/api/v1/config/drop-rules/{slug}"
tags: ["DropRule"]
---

# PUT /api/v1/config/drop-rules/{slug}

`PUT /api/v1/config/drop-rules/{slug}`

## Path parameters

- `slug` string, required

## Request body

- ConfigV1UpdateDropRuleBody
  - `drop_rule` Configv1DropRule
    - `slug` string — Unique identifier of the DropRule. If a `slug` isn't provided, one will be generated based of the `name` field. You can't modify this field after the DropRule is created.
    - `name` string — Required. Name of the DropRule. You can modify this value after the DropRule is created.
    - `created_at` string, date-time — Timestamp of when the DropRule was created. Cannot be set by clients.
    - `updated_at` string, date-time — Timestamp of when the DropRule was last updated. Cannot be set by clients.
    - `mode` 'ENABLED' | 'DISABLED'
    - `filters` Configv1LabelFilter[] — Defines the conditions that determine whether to drop a metric. Drop rules can have multiple filter conditions on different labels, making it possible to drop a subset of the series matching a particular metric name.
      - `name` string — Name of the label to match.
      - `value_glob` string — Glob value of the label to match.
    - `conditional_rate_based_drop` DropRuleConditionalRateBasedDrop — No longer supported and cannot be used. Defines behavior for conditional drop policies.
      - `enabled` boolean — Enables rate-based metric dropping.
      - `rate_limit_threshold` number, double — Percentage of the licensed limit reached in order to activate the drop rule, between 0 and 100.
      - `activated_drop_duration_secs` integer — Once activated, activated_drop_duration_secs defines how long the drop rule stays activated before rechecking against the rate_limit_threshold.
    - `value_based_drop` DropRuleValueBasedDrop
      - `enabled` boolean — Enables dropping metrics based on a set value.
      - `target_drop_value` number, double — The target data point value at which to drop metrics.
    - `drop_nan_value` boolean — Drops data points if values are Not a Number (NaN). If set to true, Chronosphere drops NaN data points, along with any published staleness markers. See the [drop rules documentation](https://docs.chronosphere.io/control/shaping/rules/drop-rules#define-a-value-based-drop-rule) for more information.
  - `create_if_missing` boolean — 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.
  - `dry_run` boolean — If true, the DropRule isn't created or updated, and no response DropRule will be returned. The response will return an error if the given DropRule is invalid.

## Response `200`

A successful response containing the updated DropRule.

- Configv1UpdateDropRuleResponse
  - `drop_rule` Configv1DropRule
    - `slug` string — Unique identifier of the DropRule. If a `slug` isn't provided, one will be generated based of the `name` field. You can't modify this field after the DropRule is created.
    - `name` string — Required. Name of the DropRule. You can modify this value after the DropRule is created.
    - `created_at` string, date-time — Timestamp of when the DropRule was created. Cannot be set by clients.
    - `updated_at` string, date-time — Timestamp of when the DropRule was last updated. Cannot be set by clients.
    - `mode` 'ENABLED' | 'DISABLED'
    - `filters` Configv1LabelFilter[] — Defines the conditions that determine whether to drop a metric. Drop rules can have multiple filter conditions on different labels, making it possible to drop a subset of the series matching a particular metric name.
      - `name` string — Name of the label to match.
      - `value_glob` string — Glob value of the label to match.
    - `conditional_rate_based_drop` DropRuleConditionalRateBasedDrop — No longer supported and cannot be used. Defines behavior for conditional drop policies.
      - `enabled` boolean — Enables rate-based metric dropping.
      - `rate_limit_threshold` number, double — Percentage of the licensed limit reached in order to activate the drop rule, between 0 and 100.
      - `activated_drop_duration_secs` integer — Once activated, activated_drop_duration_secs defines how long the drop rule stays activated before rechecking against the rate_limit_threshold.
    - `value_based_drop` DropRuleValueBasedDrop
      - `enabled` boolean — Enables dropping metrics based on a set value.
      - `target_drop_value` number, double — The target data point value at which to drop metrics.
    - `drop_nan_value` boolean — Drops data points if values are Not a Number (NaN). If set to true, Chronosphere drops NaN data points, along with any published staleness markers. See the [drop rules documentation](https://docs.chronosphere.io/control/shaping/rules/drop-rules#define-a-value-based-drop-rule) for more information.

## Other responses

- `400` — Cannot update the DropRule because the request is invalid.
- `404` — Cannot update the DropRule because the slug does not exist.
- `409` — Cannot update the DropRule because there is a conflict with an existing DropRule.
- `500` — An unexpected error response.
- `default` — An undefined error response.

---

[API](https://skmtc.net/chronosphere/apis/config-v1-api.md) · [All operations](https://skmtc.net/chronosphere/apis/config-v1-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/chronosphere/config-v1-api/versions/530951bd2ccf/schema)
