Maintenance
API-Referenz für Maintenance: jeder Handler mit seinen Feldern und einem Beispiel.
Stand:
maintenance: detail
Wartung abrufen
Liefert eine einzelne Wartung per ID mit Status, geplanten und tatsächlichen Zeiten und Ankündigungstext.
- Benötigter Scope:
maintenance: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:maintenance:detail",
"payload": {
"id": "00000000-0000-4000-8000-000000000001"
}
}'
maintenance: list
Wartungen auflisten
Liefert eine gefilterte, seitenweise Liste der Wartungen, auch vergangene und abgesagte, mit Status und Zeitfenster.
- Benötigter Scope:
maintenance: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:maintenance:list",
"payload": {}
}'
Beispielantwort
Status: 200
{
"data": {
"rows": [
{
"id": "00000000-0000-4000-8000-000000000001",
"tenantId": "00000000-0000-4000-8000-000000000002",
"version": 2,
"insertedAt": "2026-01-15T09:30:00.000Z",
"modifiedAt": null,
"insertedById": "00000000-0000-4000-8000-000000000003",
"modifiedById": null,
"title": "Database upgrade",
"body": "Short read-only period while we upgrade the database.",
"status": "scheduled",
"scheduledStart": "2026-01-15T09:30:00.000Z",
"scheduledEnd": "2026-01-15T09:30:00.000Z",
"startedAt": null,
"completedAt": null,
"cancelledAt": null
}
],
"nextCursor": null
}
}
maintenance: cancel
Wartung absagen
Sagt eine geplante oder laufende Wartung ab und hält den Zeitpunkt der Absage fest.
- Benötigter Scope:
maintenance:write - Endpunkt:
POST /api/write
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id |
string (uuid) | ja | |
version |
number | 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:maintenance:cancel",
"payload": {
"id": "00000000-0000-4000-8000-000000000001",
"version": 1
}
}'
maintenance: complete
Wartung abschließen
Setzt eine laufende Wartung auf abgeschlossen und hält den tatsächlichen Abschlusszeitpunkt fest.
- Benötigter Scope:
maintenance:write - Endpunkt:
POST /api/write
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id |
string (uuid) | ja | |
version |
number | 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:maintenance:complete",
"payload": {
"id": "00000000-0000-4000-8000-000000000001",
"version": 1
}
}'
maintenance: schedule
Wartung planen
Plant ein neues Wartungsfenster mit Titel, Beschreibung und Zeitraum und verknüpft es auf Wunsch mit den betroffenen Komponenten.
- Benötigter Scope:
maintenance:write - Endpunkt:
POST /api/write
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
title |
string | ja | Titel |
body |
string | ja | Beschreibung |
scheduledStart |
string (date-time) | ja | Geplanter Start |
scheduledEnd |
string (date-time) | ja | Geplantes Ende |
componentIds |
array of string (uuid) | nein | Betroffene Komponenten |
Beispielanfrage
curl -X POST https://status.example.com/api/write \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "publicstatus:write:maintenance:schedule",
"payload": {
"title": "Database upgrade",
"body": "Short read-only period while we upgrade the database.",
"scheduledStart": "2026-01-15T09:30:00.000Z",
"scheduledEnd": "2026-01-15T09:30:00.000Z",
"componentIds": [
"00000000-0000-4000-8000-000000000001"
]
}
}'
Beispielantwort
Status: 200
{
"isSuccess": true,
"data": {
"id": "00000000-0000-4000-8000-000000000002"
}
}
maintenance: start
Wartung starten
Setzt eine geplante Wartung auf laufend und hält den tatsächlichen Startzeitpunkt fest.
- Benötigter Scope:
maintenance:write - Endpunkt:
POST /api/write
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id |
string (uuid) | ja | |
version |
number | 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:maintenance:start",
"payload": {
"id": "00000000-0000-4000-8000-000000000001",
"version": 1
}
}'