Chronosphere MutingRule API

openapi: 3.2.0
info:
  title: Chronosphere Muting Rule API
  version: v1
  description: 'Operations tagged MutingRule 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: MutingRule
paths:
  /api/v1/config/muting-rules:
    get:
      operationId: ListMutingRules
      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 MutingRule 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 MutingRule 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
      - description: 'Lists muting rules filtered by the states. If empty, all muting rules are

          included.'
        in: query
        name: states
        schema:
          items:
            enum:
            - PENDING
            - ACTIVE
            - EXPIRED
            type: string
          type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1ListMutingRulesResponse'
          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:
      - MutingRule
      security:
      - ApiKeyAuth: []
      summary: List muting rules
      x-summary-source: derived
    post:
      operationId: CreateMutingRule
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/configv1CreateMutingRuleRequest'
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1CreateMutingRuleResponse'
          description: A successful response containing the created MutingRule.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot create the MutingRule because the request is invalid.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot create the MutingRule because there is a conflict with an existing MutingRule.
        '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:
      - MutingRule
      security:
      - ApiKeyAuth: []
      summary: Create muting 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/muting-rules/{slug}:
    delete:
      operationId: DeleteMutingRule
      parameters:
      - in: path
        name: slug
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1DeleteMutingRuleResponse'
          description: A successful response.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot delete the MutingRule because it is in use.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot delete the MutingRule 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:
      - MutingRule
      security:
      - ApiKeyAuth: []
      summary: Delete muting rule
      x-summary-source: derived
    get:
      operationId: ReadMutingRule
      parameters:
      - in: path
        name: slug
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1ReadMutingRuleResponse'
          description: A successful response.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot read the MutingRule 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:
      - MutingRule
      security:
      - ApiKeyAuth: []
      summary: Read muting rule
      x-summary-source: derived
    put:
      operationId: UpdateMutingRule
      parameters:
      - in: path
        name: slug
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigV1UpdateMutingRuleBody'
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1UpdateMutingRuleResponse'
          description: A successful response containing the updated MutingRule.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot update the MutingRule because the request is invalid.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot update the MutingRule because the slug does not exist.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot update the MutingRule because there is a conflict with an existing MutingRule.
        '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:
      - MutingRule
      security:
      - ApiKeyAuth: []
      summary: Update muting 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:
    configv1MutingRuleLabelMatcherMatcherType:
      enum:
      - EXACT
      - REGEX
      - NOT_EXACT
      - NOT_REGEXP
      type: string
    configv1ListMutingRulesResponse:
      properties:
        muting_rules:
          items:
            $ref: '#/components/schemas/configv1MutingRule'
          type: array
        page:
          $ref: '#/components/schemas/configv1PageResult'
      type: object
    configv1CreateMutingRuleRequest:
      properties:
        dry_run:
          description: If `true`, validates the specified configuration without creating the MutingRule. If the specified configuration is valid, the endpoint returns a partial response without the MutingRule. If the specified configuration is invalid, the endpoint returns an error.
          type: boolean
        muting_rule:
          allOf:
          - $ref: '#/components/schemas/configv1MutingRule'
          description: The MutingRule to create.
      type: object
    configv1DeleteMutingRuleResponse:
      type: object
    configv1MutingRuleLabelMatcher:
      properties:
        name:
          description: Required. Always matches against an exact label name.
          type: string
        type:
          allOf:
          - $ref: '#/components/schemas/configv1MutingRuleLabelMatcherMatcherType'
          description: Required. Determines how the label value is matched.
        value:
          description: Required. Matches against a label value based on the configured type.
          type: string
      type: object
    configv1MutingRule:
      properties:
        comment:
          description: Descriptive comment that explains why the muting rule was created.
          type: string
        created_at:
          description: Timestamp of when the MutingRule was created. Cannot be set by clients.
          format: date-time
          readOnly: true
          type: string
        ends_at:
          description: Required. Timestamp of when the muting rule stops being active.
          format: date-time
          type: string
        label_matchers:
          description: 'Required. Specifies which series are silenced by the muting rule. Alerting

            series must match all muting rule matchers to be silenced. You can''t update this

            value. Updates must specify the original value.'
          items:
            $ref: '#/components/schemas/configv1MutingRuleLabelMatcher'
          type: array
        name:
          description: The name of the MutingRule. You can modify this value after the MutingRule is created.
          type: string
        slug:
          description: The unique identifier of the MutingRule. If a `slug` isn't provided, one is generated based on the `name` field. You can't modify this field after the MutingRule is created.
          type: string
        starts_at:
          description: 'Required. Timestamp of when the muting rule becomes active. You can''t update

            this value. Updates must specify the original value.'
          format: date-time
          type: string
        updated_at:
          description: Timestamp of when the MutingRule was last updated. Cannot be set by clients.
          format: date-time
          readOnly: true
          type: string
      required:
      - name
      type: object
    genericError:
      additionalProperties: true
      type: object
    configv1ReadMutingRuleResponse:
      properties:
        muting_rule:
          $ref: '#/components/schemas/configv1MutingRule'
      type: object
    configv1CreateMutingRuleResponse:
      properties:
        muting_rule:
          $ref: '#/components/schemas/configv1MutingRule'
      type: object
    apiError:
      properties:
        message:
          description: An error message describing what went wrong.
          type: string
      type: object
    configv1UpdateMutingRuleResponse:
      properties:
        muting_rule:
          $ref: '#/components/schemas/configv1MutingRule'
      type: object
    ConfigV1UpdateMutingRuleBody:
      properties:
        create_if_missing:
          description: If `true`, the MutingRule will be created if it does not already exist, identified by `slug`. If `false`, an error will be returned if the MutingRule does not already exist.
          type: boolean
        dry_run:
          description: If `true`, validates the specified configuration without creating or updating the MutingRule. If the specified configuration is valid, the endpoint returns a partial response without the MutingRule. If the specified configuration is invalid, the endpoint returns an error.
          type: boolean
        muting_rule:
          allOf:
          - $ref: '#/components/schemas/configv1MutingRule'
          description: The MutingRule to update.
      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
    configv1CreateMutingRuleRequest_2:
      type: object
      properties:
        muting_rule:
          $ref: '#/components/schemas/configv1MutingRule_2'
        dry_run:
          type: boolean
          description: If true, the MutingRule isn't created, and no response MutingRule will be returned. The response will return an error if the given MutingRule is invalid.
    configv1MutingRuleLabelMatcher_2:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/configv1MutingRuleLabelMatcherMatcherType'
        name:
          type: string
          description: Required. Always matches against an exact label name.
        value:
          type: string
          description: Required. Matches against a label value based on the configured type.
    configv1MutingRule_2:
      type: object
      properties:
        slug:
          type: string
          description: Unique identifier of the MutingRule. If a `slug` isn't provided, one will be generated based of the `name` field. You can't modify this field after the MutingRule is created.
        name:
          type: string
          description: Required. Name of the MutingRule. You can modify this value after the MutingRule is created.
        created_at:
          type: string
          description: Timestamp of when the MutingRule was created. Cannot be set by clients.
          format: date-time
          readOnly: true
        updated_at:
          type: string
          description: Timestamp of when the MutingRule was last updated. Cannot be set by clients.
          format: date-time
          readOnly: true
        label_matchers:
          type: array
          description: 'Required. Specifies which series are silenced by the muting rule. Alerting

            series must match all muting rule matchers to be silenced. You can''t update this

            value. Updates must specify the original value.'
          items:
            $ref: '#/components/schemas/configv1MutingRuleLabelMatcher_2'
        starts_at:
          type: string
          description: 'Required. Timestamp of when the muting rule becomes active. You can''t update

            this value. Updates must specify the original value.'
          format: date-time
        ends_at:
          type: string
          description: Required. Timestamp of when the muting rule stops being active.
          format: date-time
        comment:
          type: string
          description: Descriptive comment that explains why the muting rule was created.
    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.
    ConfigV1UpdateMutingRuleBody_2:
      type: object
      properties:
        muting_rule:
          $ref: '#/components/schemas/configv1MutingRule_2'
        create_if_missing:
          type: boolean
          description: If true, the MutingRule will be created if it does not already exist, identified by slug. If false, an error will be returned if the MutingRule does not already exist.
        dry_run:
          type: boolean
          description: If true, the MutingRule isn't created or updated, and no response MutingRule will be returned. The response will return an error if the given MutingRule 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