Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ilert Incidents API

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

ilert Incidents API is one of 33 APIs that ilert publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Incidents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, and 1 JSON Schema.

This API exposes 7 operations across 4 paths, and defines 11 schemas. It is described by OpenAPI 3.0.1, at version v2.2026.5-r.3.

Requests are made against a single base URL, /api.

7 operations 4 paths 11 schemas 3 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v2.2026.5-r.3
Base URL
https://api.ilert.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

ilert Incidents API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKey). By default, every request must be authenticated.

  • apiKey — The Bearer API key of your user more info .

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 3 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Incidents 7
GET
/incidents
Get incidents.
7 params → 200
POST
/incidents
Create a new incident.
body → 200
POST
/incidents/publish-info
Forecast the affected subscribers and status pages
body → 200
GET
/incidents/{id}
Get a specific incident.
2 params → 200
PUT
/incidents/{id}
Update the specific incident.
2 params body → 200
GET
/incidents/{id}/private-subscribers
Get the subscribers (users and teams) of an incident
1 param → 200
POST
/incidents/{id}/private-subscribers
Add subscribers (users and teams) to an incident
1 param body → 204

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are IncidentWithHistory (12 properties), Incident (11 properties), IncidentNoIncludes (9 properties), ServiceNoIncludes (8 properties). Each schema is shown below with its type and property counts.

ServiceStatus
string
the service status
TeamRel
object
2 properties
UserRel
object
3 properties 1 required
IncidentStatus
string
the incident status
Incident
object
11 properties
UIMenuItem
object
2 properties
IncidentUpdate
object
6 properties
IncidentNoIncludes
object
9 properties
IncidentWithHistory
object
12 properties
TeamUserOption
object
3 properties
ServiceNoIncludes
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ilert-incidents-api-openapi.yml Raw ↑

Other APIs ilert publishes across the network.

ilert Alert Actions API
ilert Alert Sources API
ilert Alerts API
ilert Call Flow Numbers API
ilert Call Flows API
ilert Connectors API
ilert Contacts API
ilert Deployment Events API
ilert Deployment Pipelines API
ilert Escalation Policies API
ilert Event Flows API
ilert Events API