Chronosphere MappingRule API

openapi: 3.2.0
info:
  title: Chronosphere Mapping Rule API
  version: v1
  description: 'Operations tagged MappingRule across 2 of this provider''s published API definitions: chronosphere-config-v1-openapi3.json, chronosphere-openapi.yml. 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: MappingRule
paths:
  /api/v1/config/mapping-rules:
    get:
      operationId: ListMappingRules
      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 MappingRule 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 bucket_slug, where any MappingRule with a matching bucket_slug in the given list (and matches all other filters) will be returned.
        in: query
        name: bucket_slugs
        schema:
          items:
            type: string
          type: array
      - description: Filters results by name, where any MappingRule 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/configv1ListMappingRulesResponse'
          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:
      - MappingRule
      security:
      - ApiKeyAuth: []
      summary: List mapping rules
      x-summary-source: derived
    post:
      operationId: CreateMappingRule
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/configv1CreateMappingRuleRequest'
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1CreateMappingRuleResponse'
          description: A successful response containing the created MappingRule.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot create the MappingRule because the request is invalid.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot create the MappingRule because there is a conflict with an existing MappingRule.
        '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:
      - MappingRule
      security:
      - ApiKeyAuth: []
      summary: Create mapping 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/mapping-rules/{slug}:
    delete:
      operationId: DeleteMappingRule
      parameters:
      - in: path
        name: slug
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1DeleteMappingRuleResponse'
          description: A successful response.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot delete the MappingRule because it is in use.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot delete the MappingRule 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:
      - MappingRule
      security:
      - ApiKeyAuth: []
      summary: Delete mapping rule
      x-summary-source: derived
    get:
      operationId: ReadMappingRule
      parameters:
      - in: path
        name: slug
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1ReadMappingRuleResponse'
          description: A successful response.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot read the MappingRule 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:
      - MappingRule
      security:
      - ApiKeyAuth: []
      summary: Read mapping rule
      x-summary-source: derived
    put:
      operationId: UpdateMappingRule
      parameters:
      - in: path
        name: slug
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigV1UpdateMappingRuleBody'
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1UpdateMappingRuleResponse'
          description: A successful response containing the updated MappingRule.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot update the MappingRule because the request is invalid.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot update the MappingRule because the slug does not exist.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot update the MappingRule because there is a conflict with an existing MappingRule.
        '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:
      - MappingRule
      security:
      - ApiKeyAuth: []
      summary: Update mapping 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:
    configv1CreateMappingRuleResponse:
      properties:
        mapping_rule:
          $ref: '#/components/schemas/configv1MappingRule'
      type: object
    ConfigV1UpdateMappingRuleBody:
      properties:
        create_if_missing:
          description: If `true`, the MappingRule will be created if it does not already exist, identified by `slug`. If `false`, an error will be returned if the MappingRule does not already exist.
          type: boolean
        dry_run:
          description: If `true`, validates the specified configuration without creating or updating the MappingRule. If the specified configuration is valid, the endpoint returns a partial response without the MappingRule. If the specified configuration is invalid, the endpoint returns an error.
          type: boolean
        mapping_rule:
          allOf:
          - $ref: '#/components/schemas/configv1MappingRule'
          description: The MappingRule to update.
      type: object
    configv1UpdateMappingRuleResponse:
      properties:
        mapping_rule:
          $ref: '#/components/schemas/configv1MappingRule'
      type: object
    configv1MappingRuleStoragePolicy:
      properties:
        resolution:
          description: 'Deprecated: This parameter is no longer supported.'
          type: string
        retention:
          description: 'Deprecated: This parameter is no longer supported.'
          type: string
      type: object
    configv1DeleteMappingRuleResponse:
      type: object
    configv1ListMappingRulesResponse:
      properties:
        mapping_rules:
          items:
            $ref: '#/components/schemas/configv1MappingRule'
          type: array
        page:
          $ref: '#/components/schemas/configv1PageResult'
      type: object
    configv1MappingRuleMode:
      description: " - ENABLED: ENABLED rules are applied. Rules default to ENABLED.\n - PREVIEW: PREVIEW rules are not applied, but shaping impact stats\nfor them rule are recorded."
      enum:
      - ENABLED
      - PREVIEW
      type: string
    configv1AggregationType:
      enum:
      - LAST
      - MIN
      - MAX
      - MEAN
      - MEDIAN
      - COUNT
      - SUM
      - SUMSQ
      - STDEV
      - P10
      - P20
      - P30
      - P40
      - P50
      - P60
      - P70
      - P80
      - P90
      - P95
      - P99
      - P999
      - P9999
      - P25
      - P75
      - COUNT_SAMPLES
      - HISTOGRAM
      type: string
    configv1ReadMappingRuleResponse:
      properties:
        mapping_rule:
          $ref: '#/components/schemas/configv1MappingRule'
      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
    genericError:
      additionalProperties: true
      type: object
    configv1MappingRule:
      properties:
        aggregation_policy:
          allOf:
          - $ref: '#/components/schemas/MappingRuleAggregationPolicy'
          description: 'Specifies how to aggregate the metric. Cannot be set if the `drop`

            parameter is set.'
        bucket_slug:
          description: The slug of the bucket the MappingRule belongs to.
          type: string
        created_at:
          description: Timestamp of when the MappingRule was created. Cannot be set by clients.
          format: date-time
          readOnly: true
          type: string
        drop:
          description: 'Specifies whether to drop the given set of metrics. Cannot be set if the

            `aggregation_policy` object is set.'
          type: boolean
        filters:
          description: 'The filters that determine which metrics should have rules applied to them.

            To be considered a match, a metric must meet the criteria for all of the

            filters specified in this array.'
          items:
            $ref: '#/components/schemas/configv1LabelFilter'
          type: array
        mode:
          allOf:
          - $ref: '#/components/schemas/configv1MappingRuleMode'
          description: 'The operational mode for this mapping rule. If set to `enabled`, the rule

            is applied. If set to `preview`, the rule is not applied, but shaping

            impact statistics for the rule are recorded. Default: `enabled`.'
        name:
          description: The name of the MappingRule. You can modify this value after the MappingRule is created.
          type: string
        slug:
          description: The unique identifier of the MappingRule. If a `slug` isn't provided, one is generated based on the `name` field. You can't modify this field after the MappingRule is created.
          type: string
        updated_at:
          description: Timestamp of when the MappingRule was last updated. Cannot be set by clients.
          format: date-time
          readOnly: true
          type: string
      required:
      - filters
      - name
      type: object
    apiError:
      properties:
        message:
          description: An error message describing what went wrong.
          type: string
      type: object
    MappingRuleAggregationPolicy:
      properties:
        aggregation:
          allOf:
          - $ref: '#/components/schemas/configv1AggregationType'
          description: Defines the method by which metrics are aggregated.
        drop_timestamp:
          description: 'Deprecated: This parameter is no longer supported.'
          type: boolean
        interval:
          description: The interval between aggregated data points.
          type: string
        storage_policy:
          allOf:
          - $ref: '#/components/schemas/configv1MappingRuleStoragePolicy'
          description: 'Deprecated: Use `interval` instead.'
      type: object
    configv1CreateMappingRuleRequest:
      properties:
        dry_run:
          description: If `true`, validates the specified configuration without creating the MappingRule. If the specified configuration is valid, the endpoint returns a partial response without the MappingRule. If the specified configuration is invalid, the endpoint returns an error.
          type: boolean
        mapping_rule:
          allOf:
          - $ref: '#/components/schemas/configv1MappingRule'
          description: The MappingRule to create.
      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
    ConfigV1UpdateMappingRuleBody_2:
      type: object
      properties:
        mapping_rule:
          $ref: '#/components/schemas/configv1MappingRule_2'
        create_if_missing:
          type: boolean
          description: If true, the MappingRule will be created if it does not already exist, identified by slug. If false, an error will be returned if the MappingRule does not already exist.
        dry_run:
          type: boolean
          description: If true, the MappingRule isn't created or updated, and no response MappingRule will be returned. The response will return an error if the given MappingRule is invalid.
    configv1MappingRuleStoragePolicy_2:
      type: object
      properties:
        resolution:
          type: string
          description: Required resolution of the aggregated metrics.
        retention:
          type: string
          description: Required retention of the aggregated metrics.
    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*
    configv1MappingRule_2:
      type: object
      properties:
        slug:
          type: string
          description: Unique identifier of the MappingRule. If a `slug` isn't provided, one will be generated based of the `name` field. You can't modify this field after the MappingRule is created.
        name:
          type: string
          description: Required. Name of the MappingRule. You can modify this value after the MappingRule is created.
        created_at:
          type: string
          description: Timestamp of when the MappingRule was created. Cannot be set by clients.
          format: date-time
          readOnly: true
        updated_at:
          type: string
          description: Timestamp of when the MappingRule was last updated. Cannot be set by clients.
          format: date-time
          readOnly: true
        bucket_slug:
          type: string
          description: Required. Slug of the bucket the MappingRule belongs to.
        filters:
          type: array
          description: Required filters that determine to which metrics to apply the rule.
          items:
            $ref: '#/components/schemas/configv1LabelFilter_2'
        aggregation_policy:
          $ref: '#/components/schemas/MappingRuleAggregationPolicy_2'
        drop:
          type: boolean
          description: 'Whether to drop the given set of metrics. If set, then the aggregation

            policy can''t be set.'
        mode:
          $ref: '#/components/schemas/configv1MappingRuleMode'
    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.
    MappingRuleAggregationPolicy_2:
      type: object
      properties:
        aggregation:
          $ref: '#/components/schemas/configv1AggregationType'
        storage_policy:
          $ref: '#/components/schemas/configv1MappingRuleStoragePolicy_2'
        interval:
          type: string
          description: 'Interval between aggregated data points, equivalent to the resolution

            field in storage policy. If set, then the storage_policy field can''t be

            set.'
        drop_timestamp:
          type: boolean
          description: 'Deprecated: This field is no longer supported.'
    configv1CreateMappingRuleRequest_2:
      type: object
      properties:
        mapping_rule:
          $ref: '#/components/schemas/configv1MappingRule_2'
        dry_run:
          type: boolean
          description: If true, the MappingRule isn't created, and no response MappingRule will be returned. The response will return an error if the given MappingRule is invalid.
    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.'
  securitySchemes:
    ApiKeyAuth:
      description: Chronosphere API token
      in: header
      name: API-Token
      type: apiKey
x-refined-from:
- chronosphere-config-v1-openapi3.json
- chronosphere-openapi.yml