Incidents | ilert Docs

Get incidents.

get

Authorizations

Query parameters

start-indexinteger · int32Optional

an integer specifying the starting point (beginning with 0) when paging through a list of entities

Default: 0

max-resultsinteger · int32 · max: 100Optional

the maximum number of results when paging through a list of incidents. (Note: when using ?include maximum is reduced to 25)

Default: 10

servicesinteger · int64[]Optional

service IDs of the incident's affected services

fromstring · date-timeOptional

from date, ISO-UTC e.g. 2021-05-25T21:24:56.771Z, based on reportTime

untilstring · date-timeOptional

until date, ISO-UTC e.g. 2021-05-26T21:24:56.771Z, based on reportTime

Responses

200

The incidents

application/json

get

GET /api/incidents HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

The incidents

[
  {
    "id": 1,
    "summary": "text",
    "status": "INVESTIGATING",
    "message": "text",
    "sendNotification": true,
    "createdAt": "2025-07-08T10:45:54.137Z",
    "updatedAt": "2025-07-08T10:45:54.137Z",
    "affectedServices": [
      {
        "impact": "OPERATIONAL",
        "service": {
          "id": 1,
          "name": "text",
          "status": "OPERATIONAL",
          "description": "text",
          "oneOpenIncidentOnly": true,
          "showUptimeHistory": true,
          "teams": [
            {
              "id": 1,
              "name": "text"
            }
          ]
        }
      }
    ],
    "resolvedOn": "2025-07-08T10:45:54.137Z",
    "subscribed": true,
    "affectedTeams": [
      {
        "id": 1,
        "name": "text"
      }
    ]
  }
]

Create a new incident.

post

Note: depending on affected services this will publish notifications to subscribers. Use /publish-info to forecast notifications.

Authorizations

Body

idnumberOptional

summarystringOptional

statusstring · enumOptional

the incident status

Possible values:

messagestringOptional

sendNotificationbooleanOptional

createdAtstring · date-timeOptional

May be overwritten during the creation of the incident, otherwise read-only

updatedAtstring · date-timeOptional

May be overwritten during the creation of the incident, otherwise read-only

resolvedOnstring · date-timeRead-onlyOptional

Responses

200

The newly created incident

application/json

post

POST /api/incidents HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 377

{
  "id": 1,
  "summary": "text",
  "status": "INVESTIGATING",
  "message": "text",
  "sendNotification": true,
  "createdAt": "2025-07-08T10:45:54.137Z",
  "updatedAt": "2025-07-08T10:45:54.137Z",
  "affectedServices": [
    {
      "impact": "OPERATIONAL",
      "service": {
        "id": 1,
        "name": "text",
        "status": "OPERATIONAL",
        "description": "text",
        "oneOpenIncidentOnly": true,
        "showUptimeHistory": true,
        "teams": [
          {
            "id": 1,
            "name": "text"
          }
        ]
      }
    }
  ]
}

200

The newly created incident

{
  "id": 1,
  "summary": "text",
  "status": "INVESTIGATING",
  "message": "text",
  "sendNotification": true,
  "createdAt": "2025-07-08T10:45:54.137Z",
  "updatedAt": "2025-07-08T10:45:54.137Z",
  "affectedServices": [
    {
      "impact": "OPERATIONAL",
      "service": {
        "id": 1,
        "name": "text",
        "status": "OPERATIONAL",
        "description": "text",
        "oneOpenIncidentOnly": true,
        "showUptimeHistory": true,
        "teams": [
          {
            "id": 1,
            "name": "text"
          }
        ]
      }
    }
  ],
  "resolvedOn": "2025-07-08T10:45:54.137Z"
}

Forecast the affected subscribers and status pages

post

Forecast the affected subscribers and status pages as well as notifications that would be send out due to created or update incident.

Authorizations

Body

idnumberOptional

summarystringOptional

statusstring · enumOptional

the incident status

Possible values:

messagestringOptional

sendNotificationbooleanOptional

createdAtstring · date-timeOptional

May be overwritten during the creation of the incident, otherwise read-only

updatedAtstring · date-timeOptional

May be overwritten during the creation of the incident, otherwise read-only

resolvedOnstring · date-timeRead-onlyOptional

Responses

200

The forecast for the provided incident

application/json

post

POST /api/incidents/publish-info HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 377

{
  "id": 1,
  "summary": "text",
  "status": "INVESTIGATING",
  "message": "text",
  "sendNotification": true,
  "createdAt": "2025-07-08T10:45:54.137Z",
  "updatedAt": "2025-07-08T10:45:54.137Z",
  "affectedServices": [
    {
      "impact": "OPERATIONAL",
      "service": {
        "id": 1,
        "name": "text",
        "status": "OPERATIONAL",
        "description": "text",
        "oneOpenIncidentOnly": true,
        "showUptimeHistory": true,
        "teams": [
          {
            "id": 1,
            "name": "text"
          }
        ]
      }
    }
  ]
}

200

The forecast for the provided incident

{
  "statusPagesInfo": {
    "id": 1,
    "label": "text"
  },
  "privateStatusPages": 1,
  "publicStatusPages": 1,
  "privateSubscribers": 1,
  "publicSubscribers": 1
}

Get a specific incident.

get

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.

Authorizations

Path parameters

idnumberRequired

entity ID

Query parameters

Responses

200

The requested incident

application/json

get

GET /api/incidents/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

The requested incident

{
  "id": 1,
  "summary": "text",
  "status": "INVESTIGATING",
  "message": "text",
  "sendNotification": true,
  "createdAt": "2025-07-08T10:45:54.137Z",
  "updatedAt": "2025-07-08T10:45:54.137Z",
  "history": [
    {
      "id": "text",
      "content": "text",
      "creator": {
        "id": 1,
        "firstName": "text",
        "lastName": "text"
      },
      "incidentStatus": "INVESTIGATING",
      "sendNotification": true,
      "createdAt": "2025-07-08T10:45:54.137Z"
    }
  ],
  "affectedServices": [
    {
      "impact": "OPERATIONAL",
      "service": {
        "id": 1,
        "name": "text",
        "status": "OPERATIONAL",
        "description": "text",
        "oneOpenIncidentOnly": true,
        "showUptimeHistory": true,
        "teams": [
          {
            "id": 1,
            "name": "text"
          }
        ]
      }
    }
  ],
  "resolvedOn": "2025-07-08T10:45:54.137Z",
  "subscribed": true,
  "affectedTeams": [
    {
      "id": 1,
      "name": "text"
    }
  ]
}

Update the specific incident.

put

Note: the update will be automatically appended to the incident's update history and publish notifications to subscribers.

Authorizations

Path parameters

idnumberRequired

entity ID

Header parameters

If-MatchstringOptional

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.

Body

idnumberOptional

summarystringOptional

statusstring · enumOptional

the incident status

Possible values:

messagestringOptional

sendNotificationbooleanOptional

createdAtstring · date-timeOptional

May be overwritten during the creation of the incident, otherwise read-only

updatedAtstring · date-timeOptional

May be overwritten during the creation of the incident, otherwise read-only

resolvedOnstring · date-timeRead-onlyOptional

Responses

200

The updated incident

application/json

put

PUT /api/incidents/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 377

{
  "id": 1,
  "summary": "text",
  "status": "INVESTIGATING",
  "message": "text",
  "sendNotification": true,
  "createdAt": "2025-07-08T10:45:54.137Z",
  "updatedAt": "2025-07-08T10:45:54.137Z",
  "affectedServices": [
    {
      "impact": "OPERATIONAL",
      "service": {
        "id": 1,
        "name": "text",
        "status": "OPERATIONAL",
        "description": "text",
        "oneOpenIncidentOnly": true,
        "showUptimeHistory": true,
        "teams": [
          {
            "id": 1,
            "name": "text"
          }
        ]
      }
    }
  ]
}

200

The updated incident

{
  "id": 1,
  "summary": "text",
  "status": "INVESTIGATING",
  "message": "text",
  "sendNotification": true,
  "createdAt": "2025-07-08T10:45:54.137Z",
  "updatedAt": "2025-07-08T10:45:54.137Z",
  "affectedServices": [
    {
      "impact": "OPERATIONAL",
      "service": {
        "id": 1,
        "name": "text",
        "status": "OPERATIONAL",
        "description": "text",
        "oneOpenIncidentOnly": true,
        "showUptimeHistory": true,
        "teams": [
          {
            "id": 1,
            "name": "text"
          }
        ]
      }
    }
  ],
  "resolvedOn": "2025-07-08T10:45:54.137Z"
}

Get the subscribers (users and teams) of an incident

get

Authorizations

Path parameters

idnumberRequired

entity ID

Responses

200

The subscribers of the incident

application/json

get

GET /api/incidents/{id}/private-subscribers HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

The subscribers of the incident

[
  {
    "id": 1,
    "name": "text",
    "type": "USER"
  }
]

Add subscribers (users and teams) to an incident

post

Authorizations

Path parameters

idnumberRequired

entity ID

Bodyobject[]

idnumberOptional

namestringOptional

typestring · enumOptionalPossible values:

Responses

204

the response

post

POST /api/incidents/{id}/private-subscribers HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 38

[
  {
    "id": 1,
    "name": "text",
    "type": "USER"
  }
]

204

the response

No content