> For the complete documentation index, see [llms.txt](https://docs.ilert.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ilert.com/developer-docs/rest-api/api-reference.md). # API Reference The base URL, authentication and first request for the ilert REST API, and where to find each resource. The ilert REST API reads and changes what is in your ilert account: alerts, alert sources, escalation policies, on-call schedules, incidents, status pages and more. To send events from a monitoring tool, use [Events](https://docs.ilert.com/developer-docs/rest-api/api-reference/events) instead, which authenticates with an alert source's integration key rather than an API key. ## Send your first request Resources live under `https://api.ilert.com/api`, and requests and responses are JSON. Create an API key on the [**API keys**](https://app.ilert.com/api-key/list) page in ilert, then ask for your own user: ```bash curl https://api.ilert.com/api/users/current \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Accept: application/json" ``` | Response | Meaning | | ------------------------------------ | ------------------------------------------------------------------------------ | | `200` | The key works. The body is your user as JSON. | | `401` | The `Authorization` header is missing, or its value lacks the `Bearer` prefix. | | `403`, usually with code `KEY_ERROR` | ilert does not recognize the key. | ## Read these before you build | Page | What it covers | | ---------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | | [Authentication](https://docs.ilert.com/developer-docs/rest-api/api-reference/introduction/authentication) | API keys and the `Bearer` prefix | | [Team context](https://docs.ilert.com/developer-docs/rest-api/api-reference/introduction/team-context) | Which entities a list returns when you use an API key | | [Errors](https://docs.ilert.com/developer-docs/rest-api/api-reference/introduction/errors) | Status codes and the error body | | [API versioning](https://docs.ilert.com/developer-docs/rest-api/api-reference/introduction/api-versioning) | The backwards-compatibility promise | | [Early access](https://docs.ilert.com/developer-docs/rest-api/api-reference/introduction/early-access) | Endpoints under `/api/beta`, which that promise does not cover | | [API rate limits](/developer-docs/rest-api/alertsource-throttle.md) | The limits, and what a `429` means | ## Find a resource | Area | Resources | | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Alerting | [Events](https://docs.ilert.com/developer-docs/rest-api/api-reference/events), [Alerts](https://docs.ilert.com/developer-docs/rest-api/api-reference/alerts), [Alert sources](https://docs.ilert.com/developer-docs/rest-api/api-reference/alert-sources), [Alert actions](https://docs.ilert.com/developer-docs/rest-api/api-reference/alert-actions), [Connectors](https://docs.ilert.com/developer-docs/rest-api/api-reference/connectors), [Heartbeat monitors](https://docs.ilert.com/developer-docs/rest-api/api-reference/heartbeat-monitors), [Event flows](https://docs.ilert.com/developer-docs/rest-api/api-reference/event-flows), [Support hours](https://docs.ilert.com/developer-docs/rest-api/api-reference/support-hours), [Maintenance windows](https://docs.ilert.com/developer-docs/rest-api/api-reference/maintenance-windows), [Deployment events](https://docs.ilert.com/developer-docs/rest-api/api-reference/deployment-events), [Deployment pipelines](https://docs.ilert.com/developer-docs/rest-api/api-reference/deployment-pipelines) | | On-call | [Escalation policies](https://docs.ilert.com/developer-docs/rest-api/api-reference/escalation-policies), [Schedules](https://docs.ilert.com/developer-docs/rest-api/api-reference/schedules), [On calls](https://docs.ilert.com/developer-docs/rest-api/api-reference/on-calls) | | Incidents and status pages | [Incidents](https://docs.ilert.com/developer-docs/rest-api/api-reference/incidents), [Incident templates](https://docs.ilert.com/developer-docs/rest-api/api-reference/incident-templates), [Status updates](https://docs.ilert.com/developer-docs/rest-api/api-reference/status-updates), [Services](https://docs.ilert.com/developer-docs/rest-api/api-reference/services), [Service outages](https://docs.ilert.com/developer-docs/rest-api/api-reference/service-outages), [Status pages](https://docs.ilert.com/developer-docs/rest-api/api-reference/status-pages), [Postmortems](https://docs.ilert.com/developer-docs/rest-api/api-reference/incident-postmortems), [Metrics](https://docs.ilert.com/developer-docs/rest-api/api-reference/metrics) | | Call routing | [Call flows](https://docs.ilert.com/developer-docs/rest-api/api-reference/call-flows), [Call flow numbers](https://docs.ilert.com/developer-docs/rest-api/api-reference/call-flow-numbers), [Call flow sessions](https://docs.ilert.com/developer-docs/rest-api/api-reference/call-flow-sessions) | | Users and account | [Users](https://docs.ilert.com/developer-docs/rest-api/api-reference/users), [Contacts](https://docs.ilert.com/developer-docs/rest-api/api-reference/contacts), [Notification preferences](https://docs.ilert.com/developer-docs/rest-api/api-reference/notification-preferences), [Teams](https://docs.ilert.com/developer-docs/rest-api/api-reference/teams), [Account](https://docs.ilert.com/developer-docs/rest-api/api-reference/account) | | Reports | [Reports](https://docs.ilert.com/developer-docs/rest-api/api-reference/reports) | The sidebar lists every resource. The OpenAPI document behind this reference is at [`https://api.ilert.com/api-docs/openapi.json`](https://api.ilert.com/api-docs/openapi.json). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.ilert.com/developer-docs/rest-api/api-reference.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.