SigNoz alerts API

openapi: 3.0.3
info:
  contact:
    email: support@signoz.io
    name: SigNoz Support
    url: https://signoz.io
  description: OpenTelemetry-Native Logs, Metrics and Traces in a single pane
  termsOfService: https://signoz.io/terms-of-service/
  title: SigNoz alerts API
  version: ''
servers:
- description: The fully qualified URL to the SigNoz APIServer.
  url: https://{host}:{port}{base_path}
  variables:
    base_path:
      default: /
      description: The base path of the SigNoz APIServer
    host:
      default: localhost
      description: The host of the SigNoz APIServer
    port:
      default: '8080'
      description: The port of the SigNoz APIServer
tags:
- name: alerts
paths:
  /api/v1/alerts:
    get:
      deprecated: false
      description: This endpoint returns alerts for the organization
      operationId: GetAlerts
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/AlertmanagertypesDeprecatedGettableAlert'
                    type: array
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get alerts
      tags:
      - alerts
components:
  schemas:
    AlertmanagertypesDeprecatedGettableAlert:
      properties:
        annotations:
          $ref: '#/components/schemas/ModelLabelSet'
        endsAt:
          format: date-time
          type: string
        fingerprint:
          type: string
        generatorURL:
          type: string
        labels:
          $ref: '#/components/schemas/ModelLabelSet'
        receivers:
          items:
            type: string
          nullable: true
          type: array
        startsAt:
          format: date-time
          type: string
        status:
          $ref: '#/components/schemas/TypesAlertStatus'
      type: object
    RenderErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/ErrorsJSON'
        status:
          type: string
      required:
      - status
      - error
      type: object
    ModelLabelSet:
      additionalProperties:
        type: string
      type: object
    TypesAlertStatus:
      properties:
        inhibitedBy:
          items:
            type: string
          nullable: true
          type: array
        silencedBy:
          items:
            type: string
          nullable: true
          type: array
        state:
          type: string
      type: object
    ErrorsJSON:
      properties:
        code:
          type: string
        errors:
          items:
            $ref: '#/components/schemas/ErrorsResponseerroradditional'
          type: array
        message:
          type: string
        url:
          type: string
      required:
      - code
      - message
      type: object
    ErrorsResponseerroradditional:
      properties:
        message:
          type: string
      type: object
  securitySchemes:
    api_key:
      description: API Keys
      in: header
      name: SigNoz-Api-Key
      type: apiKey
    tokenizer:
      bearerFormat: Tokenizer
      description: Tokens generated by the tokenizer
      scheme: bearer
      type: http