Chronosphere DropRule API

openapi: 3.2.0
info:
  title: Chronosphere Drop Rule API
  version: v1
  description: 'Operations tagged DropRule across 3 of this provider''s published API definitions: chronosphere-config-v1-openapi3.json, chronosphere-openapi.yml, chronosphere-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{tenant}.chronosphere.io
  variables:
    tenant:
      default: tenant
      description: tenant ID assigned by the service provider
- url: /
tags:
- name: DropRule
paths:
  /api/v1/config/drop-rules:
    get:
      operationId: ListDropRules
      parameters:
      - description: 'Sets the preferred number of items to return per page. If set to `0`, the

          server will use its default value. Regardless of the value specified, clients

          must never assume how many items will be returned.'
        in: query
        name: page.max_size
        schema:
          format: int64
          type: integer
      - description: 'An opaque page token that identifies which page the client should request.

          An empty value indicates the first page.'
        in: query
        name: page.token
        schema:
          type: string
      - description: Filters results by slug, where any DropRule with a matching slug in the given list (and matches all other filters) will be returned.
        in: query
        name: slugs
        schema:
          items:
            type: string
          type: array
      - description: Filters results by name, where any DropRule with a matching name in the given list (and matches all other filters) will be returned.
        in: query
        name: names
        schema:
          items:
            type: string
          type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1ListDropRulesResponse'
          description: A successful response.
        '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.
      tags:
      - DropRule
      security:
      - ApiKeyAuth: []
      summary: List drop rules
      x-summary-source: derived
    post:
      operationId: CreateDropRule
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/configv1CreateDropRuleRequest'
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1CreateDropRuleResponse'
          description: A successful response containing the created DropRule.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot create the DropRule because the request is invalid.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot create the DropRule because there is a conflict with an existing DropRule.
        '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.
      tags:
      - DropRule
      security:
      - ApiKeyAuth: []
      summary: Create drop rule
      x-summary-source: derived
    servers:
    - url: https://{tenant}.chronosphere.io
      variables:
        tenant:
          default: tenant
          description: tenant ID assigned by the service provider
  /api/v1/config/drop-rules/{slug}:
    delete:
      operationId: DeleteDropRule
      parameters:
      - in: path
        name: slug
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1DeleteDropRuleResponse'
          description: A successful response.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot delete the DropRule because it is in use.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot delete 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.
      tags:
      - DropRule
      security:
      - ApiKeyAuth: []
      summary: Delete drop rule
      x-summary-source: derived
    get:
      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.
      tags:
      - DropRule
      security:
      - ApiKeyAuth: []
      summary: Read drop rule
      x-summary-source: derived
    put:
      operationId: UpdateDropRule
      parameters:
      - in: path
        name: slug
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigV1UpdateDropRuleBody'
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1UpdateDropRuleResponse'
          description: A successful response containing the updated DropRule.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot update the DropRule because the request is invalid.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot update the DropRule because the slug does not exist.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot update the DropRule because there is a conflict with an existing DropRule.
        '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.
      tags:
      - DropRule
      security:
      - ApiKeyAuth: []
      summary: Update drop rule
      x-summary-source: derived
    servers:
    - url: https://{tenant}.chronosphere.io
      variables:
        tenant:
          default: tenant
          description: tenant ID assigned by the service provider
components:
  schemas:
    genericError:
      additionalProperties: true
      type: object
    configv1UpdateDropRuleResponse:
      properties:
        drop_rule:
          $ref: '#/components/schemas/configv1DropRule'
      type: object
    configv1CreateDropRuleRequest:
      properties:
        drop_rule:
          allOf:
          - $ref: '#/components/schemas/configv1DropRule'
          description: The DropRule to create.
        dry_run:
          description: If `true`, validates the specified configuration without creating 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
    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: '#/components/schemas/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
    apiError:
      properties:
        message:
          description: An error message describing what went wrong.
          type: string
      type: object
    configv1ListDropRulesResponse:
      properties:
        drop_rules:
          items:
            $ref: '#/components/schemas/configv1DropRule'
          type: array
        page:
          $ref: '#/components/schemas/configv1PageResult'
      type: object
    configv1PageResult:
      properties:
        next_token:
          description: 'An opaque page token that identifies the next page of items that the

            client should request. An empty value indicates that there are no

            more items to return.'
          type: string
      type: object
    configv1ReadDropRuleResponse:
      properties:
        drop_rule:
          $ref: '#/components/schemas/configv1DropRule'
      type: object
    configv1DropRuleMode:
      enum:
      - ENABLED
      - DISABLED
      - PREVIEW
      type: string
    configv1CreateDropRuleResponse:
      properties:
        drop_rule:
          $ref: '#/components/schemas/configv1DropRule'
      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
    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/shape-metrics/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
    configv1DeleteDropRuleResponse:
      type: object
    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
    configv1CreateDropRuleRequest_2:
      type: object
      properties:
        drop_rule:
          $ref: '#/components/schemas/configv1DropRule_2'
        dry_run:
          type: boolean
          description: If true, the DropRule isn't created, and no response DropRule will be returned. The response will return an error if the given DropRule is invalid.
    ConfigV1UpdateDropRuleBody_2:
      type: object
      properties:
        drop_rule:
          $ref: '#/components/schemas/configv1DropRule_2'
        create_if_missing:
          type: boolean
          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.
        dry_run:
          type: boolean
          description: 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.
    apiError_2:
      type: object
      properties:
        code:
          type: integer
          description: An optional private error code whose values are undefined.
          format: int32
        message:
          type: string
          description: An error message describing what went wrong.
    configv1PageResult_2:
      type: object
      properties:
        next_token:
          type: string
          description: 'Opaque page token which identifies the next page of items which the

            client should request. An empty next_token indicates that there are no

            more items to return.'
    DropRuleConditionalRateBasedDrop:
      type: object
      properties:
        enabled:
          type: boolean
          description: Enables rate-based metric dropping.
        rate_limit_threshold:
          type: number
          description: 'Percentage of the licensed limit reached in order to activate the drop

            rule, between 0 and 100.'
          format: double
        activated_drop_duration_secs:
          type: integer
          description: 'Once activated, activated_drop_duration_secs defines how long the drop

            rule stays activated before rechecking against the rate_limit_threshold.'
          format: int32
      description: 'No longer supported and cannot be used.

        Defines behavior for conditional drop policies.'
    configv1DropRuleMode_2:
      type: string
      enum:
      - ENABLED
      - DISABLED
    configv1LabelFilter_2:
      type: object
      properties:
        name:
          type: string
          description: Name of the label to match.
          example: job
        value_glob:
          type: string
          description: Glob value of the label to match.
          example: myservice*
    configv1DropRule_2:
      type: object
      properties:
        slug:
          type: string
          description: 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:
          type: string
          description: Required. Name of the DropRule. You can modify this value after the DropRule is created.
        created_at:
          type: string
          description: Timestamp of when the DropRule was created. Cannot be set by clients.
          format: date-time
          readOnly: true
        updated_at:
          type: string
          description: Timestamp of when the DropRule was last updated. Cannot be set by clients.
          format: date-time
          readOnly: true
        mode:
          $ref: '#/components/schemas/configv1DropRuleMode_2'
        filters:
          type: array
          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_2'
        conditional_rate_based_drop:
          $ref: '#/components/schemas/DropRuleConditionalRateBasedDrop'
        value_based_drop:
          $ref: '#/components/schemas/DropRuleValueBasedDrop'
        drop_nan_value:
          type: boolean
          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.'
    configv1CreateDropRuleRequest_3:
      type: object
      properties:
        drop_rule:
          $ref: '#/components/schemas/configv1DropRule_3'
        dry_run:
          type: boolean
          description: If true, the DropRule isn't created, and no response DropRule will be returned. The response will return an error if the given DropRule is invalid.
    ConfigV1UpdateDropRuleBody_3:
      type: object
      properties:
        drop_rule:
          $ref: '#/components/schemas/configv1DropRule_3'
        create_if_missing:
          type: boolean
          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.
        dry_run:
          type: boolean
          description: 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.
    apiError_3:
      type: object
      properties:
        code:
          type: integer
          description: An optional private error code whose values are undefined.
          format: int32
        message:
          type: string
          description: An error message describing what went wrong.
    configv1PageResult_3:
      type: object
      properties:
        next_token:
          type: string
          description: 'Opaque page token which identifies the next page of items which the

            client should request. An empty next_token indicates that there are no

            more items to return.'
    configv1DropRuleMode_3:
      type: string
      enum:
      - ENABLED
      - DISABLED
    configv1LabelFilter_3:
      type: object
      properties:
        name:
          type: string
          description: Name of the label to match.
          example: job
        value_glob:
          type: string
          description: Glob value of the label to match.
          example: myservice*
    configv1DropRule_3:
      type: object
      properties:
        slug:
          type: string
          description: 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:
          type: string
          description: Required. Name of the DropRule. You can modify this value after the DropRule is created.
        created_at:
          type: string
          description: Timestamp of when the DropRule was created. Cannot be set by clients.
          format: date-time
          readOnly: true
        updated_at:
          type: string
          description: Timestamp of when the DropRule was last updated. Cannot be set by clients.
          format: date-time
          readOnly: true
        mode:
          $ref: '#/components/schemas/configv1DropRuleMode_3'
        filters:
          type: array
          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_3'
        conditional_rate_based_drop:
          $ref: '#/components/schemas/DropRuleConditionalRateBasedDrop'
        value_based_drop:
          $ref: '#/components/schemas/DropRuleValueBasedDrop'
        drop_nan_value:
          type: boolean
          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.'
  securitySchemes:
    ApiKeyAuth:
      description: Chronosphere API token
      in: header
      name: API-Token
      type: apiKey
x-refined-from:
- chronosphere-config-v1-openapi3.json
- chronosphere-openapi.yml
- chronosphere-openapi.yaml