Vorfälle

Notizen
Expertenniveau
Der API-Schlüssel sollte als Bearer-Token im Authorization-Header der Anfrage gesendet werden. Holen Sie sich Ihren API-Schlüssel.
Liste

API-Endpunkt:

GET 
https://uptimeworld.com/api/v1/incidents

Anfragebeispiel: 

curl --location --request GET 'https://uptimeworld.com/api/v1/incidents' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
search
optional string
Die Suchanfrage.
search_by
optional string
Suchen nach. Mögliche Werte sind: monitor für Monitor, cause für Ursache. Standardmässig: url.
monitor_id
optional string
Monitor-ID.
status
optional string
Status. Mögliche Werte sind: unresolved für Ungeklärt, acknowledged für Anerkannt, resolved für Gelöst.
sort_by
optional string
Sortieren nach. Mögliche Werte sind: started_at für Datum begonnen, ended_at für Datum beendet. Standardmässig: ended_at.
sort
optional string
Sortieren. Mögliche Werte sind: desc für Absteigend, asc für Aufsteigend. Standardmässig: desc.
per_page
optional integer
Ergebnisse pro Seite. Mögliche Werte sind: 10, 25, 50, 100. Standardmässig: 10.
Anzeigen

API-Endpunkt:

GET 
https://uptimeworld.com/api/v1/incidents/{id}

Anfragebeispiel: 

curl --location --request GET 'https://uptimeworld.com/api/v1/incidents/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Aktualisieren

API-Endpunkt:

PUT PATCH 
https://uptimeworld.com/api/v1/incidents/{id}

Anfragebeispiel: 

curl --location --request PUT 'https://uptimeworld.com/api/v1/incidents/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'
Parameter
Typ
Beschreibung
comment
optional string
Kommentar.
acknowledged_at
optional boolean
Anerkennen.
Löschen

API-Endpunkt:

DELETE 
https://uptimeworld.com/api/v1/incidents/{id}

Anfragebeispiel: 

curl --location --request DELETE 'https://uptimeworld.com/api/v1/incidents/{id}' \
--header 'Authorization: Bearer {api_key}'