ilert

ilert Incidents API

The Incidents API from ilert — 4 operation(s) for incidents.

Documentation GitHub OpenAPI

Business capability

Incident Response Management BC-4220.30

Operations 7

GET /incidents Get incidents #

POST /incidents Create a new incident #

POST /incidents/publish-info Forecast the affected subscribers and status pages #

GET /incidents/{id} Get a specific incident #

PUT /incidents/{id} Update the specific incident #

GET /incidents/{id}/private-subscribers Get the subscribers (users and teams) of an incident #

POST /incidents/{id}/private-subscribers Add subscribers (users and teams) to an incident #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/ilert-incidents-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: ilert REST Incidents 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: Incidents
paths:
  /incidents:
    get:
      tags:
      - Incidents
      summary: Get incidents
      parameters:
      - name: start-index
        in: query
        description: an integer specifying the starting point (beginning with 0) when paging through a list of entities
        schema:
          type: integer
          format: int32
          default: 0
      - name: max-results
        in: query
        description: 'the maximum number of results when paging through a list of incidents. (Note: when using ?include maximum is reduced to 25)'
        schema:
          maximum: 100
          type: integer
          format: int32
          default: 10
      - name: include
        in: query
        description: Describes optional properties that should be included in the response. You may declare multiple. (subscribed)
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - subscribed
      - name: states
        in: query
        description: state of the alert
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - INVESTIGATING
            - IDENTIFIED
            - MONITORING
            - RESOLVED
      - name: services
        in: query
        description: service IDs of the incident's affected services
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
            format: int64
      - name: from
        in: query
        description: from date, ISO-UTC e.g. 2021-05-25T21:24:56.771Z, based on reportTime
        schema:
          type: string
          format: date-time
      - name: until
        in: query
        description: until date, ISO-UTC e.g. 2021-05-26T21:24:56.771Z, based on reportTime
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: The incidents
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Incident'
      operationId: getIncidents
      x-operation-id-source: derived
    post:
      tags:
      - Incidents
      summary: Create a new incident
      description: 'Note: depending on affected services this will publish notifications to subscribers. Use /publish-info to forecast notifications.'
      requestBody:
        description: the incident
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IncidentNoIncludes'
        required: true
      responses:
        '200':
          description: The newly created incident
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncidentNoIncludes'
      x-codegen-request-body-name: incident
      operationId: postIncidents
      x-operation-id-source: derived
  /incidents/publish-info:
    post:
      tags:
      - Incidents
      summary: Forecast the affected subscribers and status pages
      description: Forecast the affected subscribers and status pages as well as notifications that would be send out due to created or update incident.
      requestBody:
        description: the incident
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IncidentNoIncludes'
        required: true
      responses:
        '200':
          description: The forecast for the provided incident
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusPagesInfo:
                    $ref: '#/components/schemas/UIMenuItem'
                  privateStatusPages:
                    type: number
                    readOnly: true
                  publicStatusPages:
                    type: number
                    readOnly: true
                  privateSubscribers:
                    type: number
                    readOnly: true
                  publicSubscribers:
                    type: number
                    readOnly: true
      x-codegen-request-body-name: incident
      operationId: postIncidentsPublishInfo
      x-operation-id-source: derived
  /incidents/{id}:
    get:
      tags:
      - Incidents
      summary: Get a specific incident
      description: 'Note: returns an ETag header that can be send to the PUT /incidents/{id} resource as If-Match header to return a 412 Error in case any related resources e.g. Services or Incident have been updated in the mean time.'
      parameters:
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: number
      - name: include
        in: query
        description: Describes optional properties that should be included in the response. You may declare multiple. (subscribed, affectedTeams, history)
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - subscribed
            - affectedTeams
            - history
      responses:
        '200':
          description: The requested incident
          headers:
            ETag:
              description: Send to the PUT /incidents/{id} resource as If-Match header to return a 412 Error in case any related resources e.g. Services or Incident have been updated in the mean time.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncidentWithHistory'
      operationId: getIncidentsById
      x-operation-id-source: derived
    put:
      tags:
      - Incidents
      summary: Update the specific incident
      description: 'Note: the update will be automatically appended to the incident''s update history and publish notifications to subscribers.'
      parameters:
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: number
      - name: If-Match
        in: header
        description: Should be the ETag response header retrieved from GET /incidents/{id} to prevent updating the incident based on outdated information. Will return 412 status code in case of conflict.
        schema:
          type: string
      requestBody:
        description: the incident
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IncidentNoIncludes'
        required: true
      responses:
        '200':
          description: The updated incident
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncidentNoIncludes'
      x-codegen-request-body-name: incident
      operationId: putIncidentsById
      x-operation-id-source: derived
  /incidents/{id}/private-subscribers:
    get:
      tags:
      - Incidents
      summary: Get the subscribers (users and teams) of an incident
      parameters:
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: number
      responses:
        '200':
          description: The subscribers of the incident
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TeamUserOption'
      operationId: getIncidentsByIdPrivateSubscribers
      x-operation-id-source: derived
    post:
      tags:
      - Incidents
      summary: Add subscribers (users and teams) to an incident
      parameters:
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: number
      requestBody:
        description: subscribers that should be added
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/TeamUserOption'
        required: true
      responses:
        '204':
          description: the response
          content: {}
      x-codegen-request-body-name: subscribers
      operationId: postIncidentsByIdPrivateSubscribers
      x-operation-id-source: derived
components:
  schemas:
    IncidentStatus:
      type: string
      description: the incident status
      enum:
      - INVESTIGATING
      - IDENTIFIED
      - MONITORING
      - RESOLVED
    UserRel:
      required:
      - id
      type: object
      properties:
        id:
          type: integer
          format: int64
        firstName:
          type: string
        lastName:
          type: string
    IncidentNoIncludes:
      type: object
      properties:
        id:
          type: number
        summary:
          type: string
        status:
          $ref: '#/components/schemas/IncidentStatus'
        message:
          type: string
        sendNotification:
          type: boolean
        createdAt:
          type: string
          description: May be overwritten during the creation of the incident, otherwise read-only
          format: date-time
        updatedAt:
          type: string
          description: May be overwritten during the creation of the incident, otherwise read-only
          format: date-time
        affectedServices:
          type: array
          items:
            type: object
            properties:
              impact:
                $ref: '#/components/schemas/ServiceStatus'
              service:
                $ref: '#/components/schemas/ServiceNoIncludes'
        resolvedOn:
          type: string
          format: date-time
          readOnly: true
    UIMenuItem:
      type: object
      properties:
        id:
          type: number
        label:
          type: string
    Incident:
      type: object
      properties:
        id:
          type: number
        summary:
          type: string
        status:
          $ref: '#/components/schemas/IncidentStatus'
        message:
          type: string
        sendNotification:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        affectedServices:
          type: array
          items:
            type: object
            properties:
              impact:
                $ref: '#/components/schemas/ServiceStatus'
              service:
                $ref: '#/components/schemas/ServiceNoIncludes'
        resolvedOn:
          type: string
          format: date-time
          readOnly: true
        subscribed:
          type: boolean
          readOnly: true
        affectedTeams:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/TeamRel'
    TeamUserOption:
      type: object
      properties:
        id:
          type: number
        name:
          type: string
        type:
          type: string
          enum:
          - USER
          - TEAM
    ServiceNoIncludes:
      type: object
      properties:
        id:
          type: number
        name:
          type: string
        alias:
          type: string
        status:
          $ref: '#/components/schemas/ServiceStatus'
        description:
          type: string
        oneOpenIncidentOnly:
          type: boolean
        showUptimeHistory:
          type: boolean
        teams:
          type: array
          items:
            $ref: '#/components/schemas/TeamRel'
    IncidentUpdate:
      type: object
      properties:
        id:
          type: string
        content:
          type: string
        creator:
          $ref: '#/components/schemas/UserRel'
        incidentStatus:
          $ref: '#/components/schemas/IncidentStatus'
        sendNotification:
          type: boolean
        createdAt:
          type: string
          format: date-time
    TeamRel:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    ServiceStatus:
      type: string
      description: the service status
      enum:
      - OPERATIONAL
      - UNDER_MAINTENANCE
      - DEGRADED
      - PARTIAL_OUTAGE
      - MAJOR_OUTAGE
    IncidentWithHistory:
      type: object
      properties:
        id:
          type: number
        summary:
          type: string
        status:
          $ref: '#/components/schemas/IncidentStatus'
        message:
          type: string
        sendNotification:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        history:
          type: array
          items:
            $ref: '#/components/schemas/IncidentUpdate'
        affectedServices:
          type: array
          items:
            type: object
            properties:
              impact:
                $ref: '#/components/schemas/ServiceStatus'
              service:
                $ref: '#/components/schemas/ServiceNoIncludes'
        resolvedOn:
          type: string
          format: date-time
          readOnly: true
        subscribed:
          type: boolean
          readOnly: true
        affectedTeams:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/TeamRel'
  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'

ilert Incidents API

Operations 7

Documentation

Specifications

Schemas & Data

Other Resources