> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chronosphere.io/llms.txt
> Use this file to discover all available pages before exploring further.

# ReadDropRule



## OpenAPI

````yaml openapi/api_v1_config_openapi3_DOCUMENTATION_ONLY.json GET /api/v1/config/drop-rules/{slug}
openapi: 3.0.3
info:
  description: >

    The Config API provides standard HTTP/JSON REST endpoints for creating,
    reading,

    updating, deleting, and listing configurable Chronosphere resources.


    Use this link to download the raw Swagger specification:

    <a href="/api/v1/config/swagger.json">/api/v1/config/swagger.json</a>
  title: Config V1 API
  version: v1
servers:
  - url: https://{tenant}.chronosphere.io
    variables:
      tenant:
        default: tenant
        description: tenant ID assigned by the service provider
security:
  - ApiKeyAuth: []
tags:
  - name: ConfigV1
paths:
  /api/v1/config/drop-rules/{slug}:
    get:
      tags:
        - DropRule
      operationId: ReadDropRule
      parameters:
        - in: path
          name: slug
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1ReadDropRuleResponse'
          description: A successful response.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot read the DropRule because the slug does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: An unexpected error response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/genericError'
          description: An undefined error response.
components:
  schemas:
    configv1ReadDropRuleResponse:
      properties:
        drop_rule:
          $ref: '#/components/schemas/configv1DropRule'
      type: object
    apiError:
      properties:
        message:
          description: An error message describing what went wrong.
          type: string
      type: object
    genericError:
      additionalProperties: true
      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

            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.
          type: boolean
        filters:
          description: >-
            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.
          items:
            $ref: '#/components/schemas/configv1LabelFilter'
          type: array
        mode:
          allOf:
            - $ref: '#/components/schemas/configv1DropRuleMode'
          description: >-
            If set to `DISABLED`, then the rule isn't applied when ingesting
            data points

            and 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: '#/components/schemas/DropRuleValueBasedDrop'
          description: >-
            Drops metrics based on values of `0` or `1`. This type of drop rule
            can

            significantly reduce data points per second, but changes metrics
            from continuous

            series to sparse metrics. Adding a rule of this type can change the
            behavior of

            existing monitors or dashboards that use the target metric.
      required:
        - name
      type: object
    configv1LabelFilter:
      properties:
        name:
          description: The name of the label to match.
          example: job
          type: string
        value_glob:
          description: The glob value of the label to match.
          example: myservice*
          type: string
      type: object
    configv1DropRuleMode:
      enum:
        - ENABLED
        - DISABLED
        - PREVIEW
      type: string
    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
  securitySchemes:
    ApiKeyAuth:
      description: Chronosphere API token
      in: header
      name: API-Token
      type: apiKey

````