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

# Status Page Incidents

## Get all incidents

> Get a list of all the incidents

```json
{"openapi":"3.1.0","info":{"title":"Spike API","version":"1.0.0"},"tags":[{"name":"Status Page Incidents"}],"servers":[{"url":"https://statuspage.spike.sh","description":"Status page server"}],"paths":{"/api/status-page/{status_page_id}/incidents":{"get":{"summary":"Get all incidents","description":"Get a list of all the incidents","tags":["Status Page Incidents"],"parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"Your API key. Find it in your Spike dashboard under Settings > API."},{"name":"status_page_id","in":"path","required":true,"schema":{"type":"string"},"description":"status_page_id parameter"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string","description":"Error message describing the problem"},"error":{"type":"string","description":"Error type or code"}}}}}}
```

## Get an incident

> Gets a list of all the incidents occurred on a status page

```json
{"openapi":"3.1.0","info":{"title":"Spike API","version":"1.0.0"},"tags":[{"name":"Status Page Incidents"}],"servers":[{"url":"https://statuspage.spike.sh","description":"Status page server"}],"paths":{"/api/status-page/{status_page_id}/incident/{incident_id}":{"get":{"summary":"Get an incident","description":"Gets a list of all the incidents occurred on a status page","tags":["Status Page Incidents"],"parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"Your API key. Find it in your Spike dashboard under Settings > API."},{"name":"status_page_id","in":"path","required":true,"schema":{"type":"string"},"description":"status_page_id parameter"},{"name":"incident_id","in":"path","required":true,"schema":{"type":"string"},"description":"incident_id parameter"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string","description":"Error message describing the problem"},"error":{"type":"string","description":"Error type or code"}}}}}}
```

## Create a new incident

> Creates a new incident on a status page\
> \
> \`\`\` json\
> {\
> &#x9;"title": "TITLE OF THE INCIDENT 4",\
> &#x9;"desc": "description about the incident",\
> &#x9;"severity": "degraded-performance",\
> &#x9;"componentStatus": \[{\
> &#x9;		"id": "{{ \_.component\_id }}",\
> &#x9;		"status": "critical-outage"\
> &#x9;	}],\
> &#x9;"identifiedAt": "DD/MM/YYYY",\
> &#x9;"identifiedAtTime": "05:00"\
> }\
> \`\`\`\
> \
> \### Params:\
> \
> \### \\\* ALL THE TIMESTAMPS SHOULD BE IN UTC\
> \
> \
> \`componentStatus \*\`: Accepts a collection of objects used to set status to multiple components at once. Accepted values of component status are \`operational\`, \`degraded-performance\`, \`partial-outage\`, \`critical-outage\`.\
> \
> \`title \*\`: Title of the incident.\
> \
> \`desc \*\`: Description of the incident\
> \
> \`severity \*\`: Impact of incident on the status page. Possible values - \`operational\`, \`degraded-performance\`, \`partial-outage\`, \`critical-outage\`.\
> \
> \`notify\`: Specify if you want to notify subscribers about the incident. Defaults to \`false\`. \`Type: Boolean\`\
> \
> \`identifiedAtTime\`: Specify the time when the incident was triggered in 24 Hour format. \`Default\`: \`Current time in UTC\`\
> \
> \`identifiedAt\`: Specify the date of the incident in UTC. \`Default\`: \`Current Date in UTC\`\
> \
> \\\* Required<br>

````json
{"openapi":"3.1.0","info":{"title":"Spike API","version":"1.0.0"},"tags":[{"name":"Status Page Incidents"}],"servers":[{"url":"https://statuspage.spike.sh","description":"Status page server"}],"paths":{"/api/status-page/{status_page_id}/incident/new":{"post":{"summary":"Create a new incident","description":"Creates a new incident on a status page\n\n``` json\n{\n\t\"title\": \"TITLE OF THE INCIDENT 4\",\n\t\"desc\": \"description about the incident\",\n\t\"severity\": \"degraded-performance\",\n\t\"componentStatus\": [{\n\t\t\t\"id\": \"{{ _.component_id }}\",\n\t\t\t\"status\": \"critical-outage\"\n\t\t}],\n\t\"identifiedAt\": \"DD/MM/YYYY\",\n\t\"identifiedAtTime\": \"05:00\"\n}\n```\n\n### Params:\n\n### \\* ALL THE TIMESTAMPS SHOULD BE IN UTC\n\n\n`componentStatus *`: Accepts a collection of objects used to set status to multiple components at once. Accepted values of component status are `operational`, `degraded-performance`, `partial-outage`, `critical-outage`.\n\n`title *`: Title of the incident.\n\n`desc *`: Description of the incident\n\n`severity *`: Impact of incident on the status page. Possible values - `operational`, `degraded-performance`, `partial-outage`, `critical-outage`.\n\n`notify`: Specify if you want to notify subscribers about the incident. Defaults to `false`. `Type: Boolean`\n\n`identifiedAtTime`: Specify the time when the incident was triggered in 24 Hour format. `Default`: `Current time in UTC`\n\n`identifiedAt`: Specify the date of the incident in UTC. `Default`: `Current Date in UTC`\n\n\\* Required\n","tags":["Status Page Incidents"],"parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"Your API key. Find it in your Spike dashboard under Settings > API."},{"name":"status_page_id","in":"path","required":true,"schema":{"type":"string"},"description":"status_page_id parameter"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"desc":{"type":"string"},"severity":{"type":"string"},"componentStatus":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"}}}},"identifiedAtTime":{"type":"string"},"identifiedAt":{"type":"string"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string","description":"Error message describing the problem"},"error":{"type":"string","description":"Error type or code"}}}}}}
````

## Edit an incident

> Edit an incident on a status page\
> \
> \`\`\`\
> {\
> &#x9;"title": "EDITED TITLE OF THE INCIDENT 4",\
> &#x9;"desc": "edited description about the incident",\
> &#x9;"severity": "degraded-performance",\
> &#x9;"componentStatus": \[{\
> &#x9;		"id": "{{ \_.component\_id }}",\
> &#x9;		"status": "critical-outage"\
> &#x9;	}]\
> }\
> \`\`\`\
> \
> \### Params:\
> \
> \`componentStatus \*\`: Accepts a collection of objects used to set status to multiple components at once. Accepted values of component status are \`operational\`, \`degraded-performance\`, \`partial-outage\`, \`critical-outage\`.\
> \
> \`title \*\`: Title of the incident.\
> \
> \`desc \*\`: Description of the incident\
> \
> \`severity \*\`: Impact of incident on the status page. Possible values - \`operational\`, \`degraded-performance\`, \`partial-outage\`, \`critical-outage\`.\
> \
> \
> \\\* Required<br>

````json
{"openapi":"3.1.0","info":{"title":"Spike API","version":"1.0.0"},"tags":[{"name":"Status Page Incidents"}],"servers":[{"url":"https://statuspage.spike.sh","description":"Status page server"}],"paths":{"/api/status-page/{status_page_id}/incident/{incident_id}/edit":{"post":{"summary":"Edit an incident","description":"Edit an incident on a status page\n\n```\n{\n\t\"title\": \"EDITED TITLE OF THE INCIDENT 4\",\n\t\"desc\": \"edited description about the incident\",\n\t\"severity\": \"degraded-performance\",\n\t\"componentStatus\": [{\n\t\t\t\"id\": \"{{ _.component_id }}\",\n\t\t\t\"status\": \"critical-outage\"\n\t\t}]\n}\n```\n\n### Params:\n\n`componentStatus *`: Accepts a collection of objects used to set status to multiple components at once. Accepted values of component status are `operational`, `degraded-performance`, `partial-outage`, `critical-outage`.\n\n`title *`: Title of the incident.\n\n`desc *`: Description of the incident\n\n`severity *`: Impact of incident on the status page. Possible values - `operational`, `degraded-performance`, `partial-outage`, `critical-outage`.\n\n\n\\* Required\n","tags":["Status Page Incidents"],"parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"Your API key. Find it in your Spike dashboard under Settings > API."},{"name":"status_page_id","in":"path","required":true,"schema":{"type":"string"},"description":"status_page_id parameter"},{"name":"incident_id","in":"path","required":true,"schema":{"type":"string"},"description":"incident_id parameter"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"desc":{"type":"string"},"severity":{"type":"string"},"componentStatus":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"}}}}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string","description":"Error message describing the problem"},"error":{"type":"string","description":"Error type or code"}}}}}}
````

## Add a status update to incident

> Add a status update to a status page incident\
> \
> \`\`\`\
> {\
> &#x9;"componentStatus": \[{\
> &#x9;	"id": "{{ \_.component\_id }}",\
> &#x9;	"status": "operational"\
> &#x9;}],\
> &#x9;"title": "this is a status update",\
> &#x9;"status": "update",\
> &#x9;"notify": true,\
> &#x9;"time": "05:00",\
> &#x9;"date": "10/07/2023"\
> \
> }\
> \`\`\`\
> \
> \### Params:\
> \
> \### \\\* ALL THE TIMESTAMPS SHOULD BE IN UTC\
> \
> \`componentStatus \*\`: Accepts a collection of objects used to set status to multiple components at once.. Accepted values of component status are \`operational\`, \`degraded-performance\`, \`partial-outage\`, \`critical-outage\`.\
> \
> \`title \*\`: Title of the incident.\
> \
> \`status \*\`: Type of the update. The value of the update can be any of the following - \`investigating\`, \`identified\`, \`resolved\`, \`update\`, \`postmortem\`.\
> \
> \`notify\`: Specify if you want to notify the subscribers of the page. default is \`false\`. \`Type: Boolean\`\
> \
> \`date\`: date of the update in \`DD/MM/YYYY\` format, otherwise defaults to current date in UTC. \
> \
> \`time\`: time of the update, defaults to current time in UTC. \
> \
> \
> \\\* Required<br>

````json
{"openapi":"3.1.0","info":{"title":"Spike API","version":"1.0.0"},"tags":[{"name":"Status Page Incidents"}],"servers":[{"url":"https://statuspage.spike.sh","description":"Status page server"}],"paths":{"/api/status-page/{status_page_id}/incident/{incident_id}/add-status":{"post":{"summary":"Add a status update to incident","description":"Add a status update to a status page incident\n\n```\n{\n\t\"componentStatus\": [{\n\t\t\"id\": \"{{ _.component_id }}\",\n\t\t\"status\": \"operational\"\n\t}],\n\t\"title\": \"this is a status update\",\n\t\"status\": \"update\",\n\t\"notify\": true,\n\t\"time\": \"05:00\",\n\t\"date\": \"10/07/2023\"\n\n}\n```\n\n### Params:\n\n### \\* ALL THE TIMESTAMPS SHOULD BE IN UTC\n\n`componentStatus *`: Accepts a collection of objects used to set status to multiple components at once.. Accepted values of component status are `operational`, `degraded-performance`, `partial-outage`, `critical-outage`.\n\n`title *`: Title of the incident.\n\n`status *`: Type of the update. The value of the update can be any of the following - `investigating`, `identified`, `resolved`, `update`, `postmortem`.\n\n`notify`: Specify if you want to notify the subscribers of the page. default is `false`. `Type: Boolean`\n\n`date`: date of the update in `DD/MM/YYYY` format, otherwise defaults to current date in UTC. \n\n`time`: time of the update, defaults to current time in UTC. \n\n\n\\* Required\n","tags":["Status Page Incidents"],"parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"Your API key. Find it in your Spike dashboard under Settings > API."},{"name":"status_page_id","in":"path","required":true,"schema":{"type":"string"},"description":"status_page_id parameter"},{"name":"incident_id","in":"path","required":true,"schema":{"type":"string"},"description":"incident_id parameter"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"componentStatus":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"}}}},"title":{"type":"string"},"status":{"type":"string"},"time":{"type":"string"},"date":{"type":"string"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string","description":"Error message describing the problem"},"error":{"type":"string","description":"Error type or code"}}}}}}
````


---

# 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.spike.sh/spike-api-docs/status-page-incidents.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.