ilert Events API

openapi: 3.2.0
info:
  title: ilert REST Events API
  description: '# Introduction

    The ilert API is a RESTful API and provides programmatic access to entities in ilert and lets you easily integrate ilert with 3rd party tools.'
  version: v2.2026.5-r.3
  x-logo:
    url: ./ilert-logo-spaced.png
    backgroundColor: '#fafafa'
    altText: ilert documentation logo
servers:
- url: /api
security:
- apiKey: []
tags:
- name: Events
paths:
  /events:
    post:
      tags:
      - Events
      summary: Post an event to ilert
      description: Use the Event API to integrate your monitoring or ticketing tools with ilert.
      requestBody:
        description: The event
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Event'
        required: true
      responses:
        '202':
          description: The event has been accepted
          content: {}
      security: []
      x-codegen-request-body-name: event
      operationId: postEvents
      x-operation-id-source: derived
components:
  schemas:
    EventComment:
      type: object
      properties:
        creator:
          type: string
        content:
          type: string
    EventLink:
      type: object
      properties:
        href:
          type: string
        text:
          type: string
    Event:
      required:
      - integrationKey
      - eventType
      - summary
      type: object
      properties:
        integrationKey:
          type: string
        eventType:
          type: string
          description: the event type
          enum:
          - ALERT
          - ACCEPT
          - RESOLVE
          - COMMENT
        summary:
          type: string
          description: The event summary. Will be used as the alert summary if a new alert will be created.
        details:
          type: string
          description: The event details. Will be used as the alert details if a new alert will be created.
        alertKey:
          type: string
          description: Used to deduplicate events. If an open alert with the key already exists, the event will be appended to the alert's event log. Otherwise a new alert will be created. We will trim this value if necessary. Upper casing is allowed, however comparison is case insensitive.
        priority:
          $ref: '#/components/schemas/AlertPriority'
        severity:
          maximum: 5
          minimum: 1
          type: integer
          format: int32
          description: Optional severity in range 1..5. Will overwrite the evaluated severity of the alert source.
        images:
          type: array
          items:
            $ref: '#/components/schemas/EventImage'
        links:
          type: array
          items:
            $ref: '#/components/schemas/EventLink'
        comments:
          type: array
          items:
            $ref: '#/components/schemas/EventComment'
        labels:
          type: object
          additionalProperties:
            type: string
          description: Optional key/value labels that are attached to the alert.
        services:
          type: array
          items:
            $ref: '#/components/schemas/EventServiceRef'
          description: Optional list of service refs. Usually pass alias; id is optional for rare edge cases.
        customDetails:
          type: object
          additionalProperties: true
        routingKey:
          type: string
          description: Optional routing key that overwrites the escalation policy of the alert source for ALERT events. Must map to routingKey of escalation policy
    EventImage:
      type: object
      properties:
        src:
          type: string
        href:
          type: string
        alt:
          type: string
    EventServiceRef:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Optional service id for rare edge cases. Prefer alias.
        alias:
          type: string
          description: Service alias (preferred).
    AlertPriority:
      type: string
      enum:
      - HIGH
      - LOW
  securitySchemes:
    apiKey:
      type: apiKey
      description: The Bearer API key of your user <a href='/api-docs/#section/Authentication'>more info</a>.
      name: Authorization
      in: header
x-original-swagger-version: '2.0'