> For the complete documentation index, see [llms.txt](https://docs.statusentry.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.statusentry.com/incident-api.md).

# Incident API

## List Incidents

<mark style="color:blue;">`GET`</mark> `https://api.statusentry.com/v1/incidents`

This endpoint allows you to get your incidents.

#### Headers

| Name          | Type   | Description         |
| ------------- | ------ | ------------------- |
| Authorization | string | Authorization token |

{% tabs %}
{% tab title="200 " %}

```
{
    "customerId": "87da60eb-d7ab-4f10-9151-7df1c09c030e",
    "incidents": [
        {
            "customerId": "87da60eb-d7ab-4f10-9151-7df1c09c030e",
            "id": "bf0c3fca-6eb7-4046-b257-833138a0be3e",
            "name": "Test incident",
            "incidentStatus": "resolved",
            "incidentImpact": "none",
            "creationTime": "1609443863653",
            "resolutionTime": "1609444055138"
        },
        {
            "customerId": "87da60eb-d7ab-4f10-9151-7df1c09c030e",
            "id": "5996776d-21d1-4d72-92be-7517a355ca96",
            "name": "Signup page is having intermittent errors.",
            "incidentStatus": "investigating",
            "incidentImpact": "minor",
            "creationTime": "1609444309698"
        }
    ]
}
```

{% endtab %}
{% endtabs %}

## Get Incident

<mark style="color:blue;">`GET`</mark> `https://api.statusentry.com/v1/incidents/:id`

This endpoint allows you to retrieve specific incident.

#### Path Parameters

| Name | Type   | Description |
| ---- | ------ | ----------- |
| id   | string | Incident ID |

#### Headers

| Name          | Type   | Description         |
| ------------- | ------ | ------------------- |
| Authorization | string | Authorization Token |

{% tabs %}
{% tab title="200 " %}

```
{
    "customerId": "87da60eb-d7ab-4f10-9151-7df1c09c030e",
    "id": "5996776d-21d1-4d72-92be-7517a355ca96",
    "name": "C",
    "incidentStatus": "investigating",
    "incidentImpact": "minor",
    "creationTime": "1609444309698"
}
```

{% endtab %}
{% endtabs %}

## Create Incident

<mark style="color:green;">`POST`</mark> `https://api.statusentry.com/v1/incidents`

This endpoint allows you to create new incident.

#### Headers

| Name          | Type   | Description         |
| ------------- | ------ | ------------------- |
| Authorization | string | Authorization Token |

#### Request Body

| Name           | Type   | Description                                                                                                                        |
| -------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------- |
| entry          | object | Incident details                                                                                                                   |
| incidentImpact | string | <p>Impact of the incident. Default value: "none"<br>Possible values:<br>"none",<br>"minor",<br>"major",<br>"critical"</p>          |
| incidentStatus | string | <p>Current status of the incident.<br>Possible values: <br>"investigating", <br>"identified", <br>"monitoring", <br>"resolved"</p> |
| name           | string | Incident message                                                                                                                   |

{% tabs %}
{% tab title="200 " %}

```
{
    "customerId": "87da60eb-d7ab-4f10-9151-7df1c09c030e",
    "id": "a2e22f11-8955-4873-96f3-0f943b325943",
    "name": "Signup page is having intermittent errors.",
    "incidentStatus": "investigating",
    "incidentImpact": "minor",
    "creationTime": "1609681547"
}
```

{% endtab %}
{% endtabs %}

An incident entry request object takes following parameters:

```
"entry":
{
    "message": "We are investigating a problem in our signup flow. We will provide an update as soon as we have more information or within 10 minutes.",
    "date": "1609681547", // epoch time in millis
    "incidentStatus": "investigating",
    "affectedComponents": [ // Optional
        {
        "componentId": "fb5e3cdc-4550-47d9-a96d-287c987f2ba02",
        "componentStatus": "degraded_performance"
    }
    ],
    "sendNotification": true // Optional, default true
}
```

## Delete Incident

<mark style="color:red;">`DELETE`</mark> `https://api.statusentry.com/v1/incidents/:id`

This endpoint allows you to delete an incident.

#### Path Parameters

| Name | Type   | Description |
| ---- | ------ | ----------- |
| id   | string | Incident ID |

#### Headers

| Name          | Type   | Description         |
| ------------- | ------ | ------------------- |
| Authorization | string | Authorization Token |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.statusentry.com/incident-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.