> For the complete documentation index, see [llms.txt](https://dev.isdown.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dev.isdown.app/endpoints/incidents.md).

# Incidents

### Incident object

| Field                | Type           | Description                                                |
| -------------------- | -------------- | ---------------------------------------------------------- |
| `id`                 | string         | Unique incident ID                                         |
| `title`              | string         | Incident title                                             |
| `description`        | string         | Latest description / initial description                   |
| `status`             | string         | `minor` or `major`                                         |
| `resolved`           | boolean        | Whether the incident is resolved                           |
| `created_at`         | string         | ISO 8601 timestamp                                         |
| `resolved_at`        | string \| null | ISO 8601 timestamp, or `null` if ongoing                   |
| `updated_at`         | string         | ISO 8601 timestamp of last update                          |
| `service`            | string         | Service name                                               |
| `service_urlname`    | string         | Service URL slug                                           |
| `service_status_url` | string         | URL of the service's own status page                       |
| `user_generated`     | boolean        | Whether this was a user-reported incident                  |
| `components`         | array          | Affected component names                                   |
| `updates`            | array          | Ordered list of incident updates (see below)               |
| `isdown_url`         | string \| null | Link to the incident on IsDown. `null` for custom services |

#### Update object

Each item in the `updates` array:

| Field         | Type   | Description                                                    |
| ------------- | ------ | -------------------------------------------------------------- |
| `status`      | string | One of `investigating`, `identified`, `monitoring`, `resolved` |
| `created_at`  | string | ISO 8601 timestamp                                             |
| `description` | string | Update message                                                 |

***

### Error responses

All errors follow the same format:

```json
{
  "errors": [
    {
      "status": 422,
      "title": "Unprocessable Entity",
      "detail": "Status must be 'minor' or 'major'"
    }
  ]
}
```