Incidents
API-Referenz für Incidents: jeder Handler mit seinen Feldern und einem Beispiel.
Stand:
incident: detail
Vorfall abrufen
Liefert einen einzelnen Vorfall per ID mit Status, Schweregrad, Beginn, Lösungszeit und eigenen Feldern.
- Benötigter Scope:
incidents:read - Endpunkt:
POST /api/query
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id |
string (uuid) | ja |
Beispielanfrage
curl -X POST https://status.example.com/api/query \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "publicstatus:query:incident:detail",
"payload": {
"id": "00000000-0000-4000-8000-000000000001"
}
}'
incident: list
Vorfälle auflisten
Liefert eine gefilterte, seitenweise Liste der Vorfälle, auch gelöste, mit Status, Schweregrad und Beginn.
- Benötigter Scope:
incidents:read - Endpunkt:
POST /api/query
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
cursor |
string | nein | Position aus nextCursor der vorherigen Seite. |
limit |
integer | nein | Zeilen pro Seite, standardmäßig 50, höchstens 200. |
search |
string | nein | Volltextsuche über die durchsuchbaren Felder. |
sort |
string | nein | Feld, nach dem sortiert wird. |
sortDirection |
“asc” | “desc” | nein | asc oder desc. |
offset |
integer | nein | Anzahl der zu überspringenden Zeilen. Nutze besser cursor zum Blättern. |
totalCount |
boolean | nein | Mit true bekommst du zusätzlich total, die Anzahl der passenden Zeilen. |
includeDeleted |
boolean | nein | Mit true sind gelöschte Zeilen enthalten. Nur für Entitäten mit Soft Delete. |
onlyDeleted |
boolean | nein | Mit true kommen nur gelöschte Zeilen zurück. Nur für Entitäten mit Soft Delete, nicht zusammen mit includeDeleted. |
filter |
object | nein | Ein Feldfilter mit field, op und value. op ist einer von eq, ne, lt, gt, lte, gte, in. |
filter.field |
string | ja | |
filter.op |
“eq” | “ne” | “lt” | “gt” | “lte” | “gte” | “in” | ja | |
filter.value |
any | ja | |
filters |
array of object | nein | Mehrere Feldfilter, je mit field, op und value. op ist einer von eq, ne, lt, gt, lte, gte, in. |
namedFilter |
string | nein | Name eines vordefinierten Filters der Entität, zum Beispiel einer Arbeitsliste. |
aggregate |
object | nein | Liefert aggregierte Werte statt Zeilen. |
aggregate.groupBy |
string | nein | |
aggregate.measures |
array of object | nein |
Beispielanfrage
curl -X POST https://status.example.com/api/query \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "publicstatus:query:incident:list",
"payload": {}
}'
Beispielantwort
Status: 200
{
"data": {
"rows": [
{
"id": "00000000-0000-4000-8000-000000000001",
"tenantId": "00000000-0000-4000-8000-000000000002",
"version": 3,
"insertedAt": "2026-01-15T09:30:00.000Z",
"modifiedAt": null,
"insertedById": "00000000-0000-4000-8000-000000000003",
"modifiedById": null,
"title": "Elevated API errors",
"status": "investigating",
"severity": "major",
"startedAt": "2026-01-15T09:30:00.000Z",
"resolvedAt": null,
"sourceMonitorId": null,
"customFields": {}
}
],
"nextCursor": null
}
}
incident: updates
Updates eines Vorfalls auflisten
Liefert den zeitlichen Verlauf der Updates eines Vorfalls, jeweils mit dem Anzeigenamen des Verfassers.
- Benötigter Scope:
incidents:read - Endpunkt:
POST /api/query
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
incidentId |
string (uuid) | ja | Vorfall |
Beispielanfrage
curl -X POST https://status.example.com/api/query \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "publicstatus:query:incident:updates",
"payload": {
"incidentId": "00000000-0000-4000-8000-000000000001"
}
}'
incident: open
Vorfall eröffnen
Eröffnet einen neuen Vorfall auf der Statusseite, verknüpft ihn mit den betroffenen Komponenten und hält das erste Update im Verlauf fest.
- Benötigter Scope:
incidents:write - Endpunkt:
POST /api/write
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
title |
string | ja | Titel |
body |
string | ja | Beschreibung |
severity |
“minor” | “major” | “critical” | nein | Schweregrad |
componentIds |
array of string (uuid) | nein | Betroffene Komponenten |
startedAt |
string (date-time) | nein | Start |
sourceMonitorId |
string (uuid) | nein |
Beispielanfrage
curl -X POST https://status.example.com/api/write \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "publicstatus:write:incident:open",
"payload": {
"title": "Elevated API errors",
"body": "We are investigating elevated error rates.",
"severity": "major",
"componentIds": [
"00000000-0000-4000-8000-000000000001"
]
}
}'
Beispielantwort
Status: 200
{
"isSuccess": true,
"data": {
"id": "00000000-0000-4000-8000-000000000002"
}
}
incident: post-update
Update zu einem Vorfall posten
Fügt einem offenen Vorfall ein Update hinzu und ändert auf Wunsch im selben Aufruf seinen Status.
- Benötigter Scope:
incidents:write - Endpunkt:
POST /api/write
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
incidentId |
string (uuid) | ja | Vorfall |
body |
string | ja | Beschreibung |
newStatus |
“investigating” | “identified” | “monitoring” | “resolved” | nein | Neuer Status |
Beispielanfrage
curl -X POST https://status.example.com/api/write \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "publicstatus:write:incident:post-update",
"payload": {
"incidentId": "00000000-0000-4000-8000-000000000001",
"body": "text",
"newStatus": "investigating"
}
}'
incident: resolve
Vorfall als gelöst markieren
Markiert einen offenen Vorfall als gelöst, hält die Lösungszeit fest und fügt dem Verlauf ein abschließendes Update hinzu.
- Benötigter Scope:
incidents:write - Endpunkt:
POST /api/write
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
incidentId |
string (uuid) | ja | Vorfall |
body |
string | ja | Beschreibung |
Beispielanfrage
curl -X POST https://status.example.com/api/write \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "publicstatus:write:incident:resolve",
"payload": {
"incidentId": "00000000-0000-4000-8000-000000000001",
"body": "text"
}
}'
incident: update
Vorfall ändern
Ändert Titel, Schweregrad, Beginn und eigene Felder eines Vorfalls, ohne den Status anzufassen. Den Status ändern nur die Aufrufe zum Eröffnen, Aktualisieren und Lösen.
- Benötigter Scope:
incidents:write - Endpunkt:
POST /api/write
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id |
string (uuid) | ja | |
version |
number | ja | |
changes |
object | ja | |
changes.title |
string | nein | Titel |
changes.status |
“investigating” | “identified” | “monitoring” | “resolved” | nein | Status |
changes.severity |
“minor” | “major” | “critical” | nein | Schweregrad |
changes.startedAt |
string (date-time) | nein | Start |
changes.resolvedAt |
string (date-time) | null | nein | Behoben |
changes.sourceMonitorId |
string | null | nein | |
changes.customFields |
object | nein |
Beispielanfrage
curl -X POST https://status.example.com/api/write \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "publicstatus:write:incident:update",
"payload": {
"id": "00000000-0000-4000-8000-000000000001",
"version": 1,
"changes": {
"title": "text",
"status": "investigating",
"severity": "minor",
"startedAt": "2026-01-15T09:30:00.000Z",
"resolvedAt": "2026-01-15T09:30:00.000Z",
"sourceMonitorId": "text",
"customFields": {}
}
}
}'