Prometheus alertgroup API

openapi: 3.2.0
info:
  version: 0.0.1
  title: Alertmanager admin Alertgroup API
  description: API of the Prometheus Alertmanager (https://github.com/prometheus/alertmanager)
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: /api/v2/
tags:
- name: alertgroup
paths:
  /alerts/groups:
    get:
      tags:
      - alertgroup
      operationId: getAlertGroups
      description: Get a list of alert groups
      parameters:
      - in: query
        name: active
        description: Include active alerts within the returned groups. If false, excludes active alerts from groups and only shows suppressed (silenced or inhibited) alerts.
        schema:
          type: boolean
          default: true
      - in: query
        name: silenced
        description: Include silenced alerts within the returned groups. If false, excludes silenced alerts from groups. Note that true (default) shows both silenced and non-silenced alerts.
        schema:
          type: boolean
          default: true
      - in: query
        name: inhibited
        description: Include inhibited alerts within the returned groups. If false, excludes inhibited alerts from groups. Note that true (default) shows both inhibited and non-inhibited alerts.
        schema:
          type: boolean
          default: true
      - in: query
        name: muted
        description: Include muted (silenced or inhibited) alert groups in results. If false, excludes entire groups where all alerts are muted.
        schema:
          type: boolean
          default: true
      - name: filter
        in: query
        description: A matcher expression to filter alert groups. For example `alertname="MyAlert"`. It can be repeated to apply multiple matchers.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: receiver
        in: query
        description: A regex matching receivers to filter alerts by
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/receiverMatchers'
      responses:
        '200':
          description: Get alert groups response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/alertGroups'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  responses:
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            type: string
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            type: string
  schemas:
    gettableAlert:
      allOf:
      - type: object
        properties:
          annotations:
            $ref: '#/components/schemas/labelSet'
          receivers:
            type: array
            items:
              $ref: '#/components/schemas/receiverReference'
          fingerprint:
            type: string
          startsAt:
            type: string
            format: date-time
          updatedAt:
            type: string
            format: date-time
          endsAt:
            type: string
            format: date-time
          status:
            $ref: '#/components/schemas/alertStatus'
        required:
        - receivers
        - fingerprint
        - startsAt
        - updatedAt
        - endsAt
        - annotations
        - status
      - $ref: '#/components/schemas/alert'
    alertGroups:
      type: array
      items:
        $ref: '#/components/schemas/alertGroup'
    labelSet:
      type: object
      additionalProperties:
        type: string
    receiverReference:
      type: object
      properties:
        name:
          type: string
      required:
      - name
    alert:
      type: object
      properties:
        labels:
          $ref: '#/components/schemas/labelSet'
        generatorURL:
          type: string
          format: uri
      required:
      - labels
    alertGroup:
      type: object
      properties:
        labels:
          $ref: '#/components/schemas/labelSet'
        receiver:
          $ref: '#/components/schemas/receiverReference'
        alerts:
          type: array
          items:
            $ref: '#/components/schemas/gettableAlert'
      required:
      - labels
      - receiver
      - alerts
    alertStatus:
      type: object
      properties:
        state:
          type: string
          enum:
          - unprocessed
          - active
          - suppressed
        silencedBy:
          type: array
          items:
            type: string
        inhibitedBy:
          type: array
          items:
            type: string
        mutedBy:
          type: array
          items:
            type: string
      required:
      - state
      - silencedBy
      - inhibitedBy
      - mutedBy
  parameters:
    receiverMatchers:
      name: receiver_matchers
      in: query
      description: A matcher expression to filter by receiver labels. For example `owner="my-team"`. Can be repeated to apply multiple matchers.
      required: false
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string