Monitore

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/monitors

Anfragebeispiel: 

curl --location --request GET 'https://uptimeworld.com/api/v1/monitors' \
--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: name für Name, url für URL. Standardmässig: name.
status_page_id
optional integer
Statusseiten-ID.
sort_by
optional string
Sortieren nach. Mögliche Werte sind: id für Erstellungsdatum, name für Name, url für URL. Standardmässig: id.
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/monitors/{id}

Anfragebeispiel: 

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

API-Endpunkt:

POST 
https://uptimeworld.com/api/v1/monitors

Anfragebeispiel: 

curl --location --request POST 'https://uptimeworld.com/api/v1/monitors' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'url={url}'
Parameter
Typ
Beschreibung
name
erforderlich string
Name.
url
erforderlich string
URL.
interval
erforderlich integer
Intervall. Mögliche Werte sind: 60, 180, 300, 600, 900, 1800, 3600.
ssl_alert_days
optional integer
Die Anzahl der Tage vor Ablauf des SSL-Zertifikats, um einen Alarm zu erhalten. Mögliche Werte sind: 0, 1, 2, 3, 7, 14, 30, 60.
maintenance_start_at
optional string
Wartungsbeginndatum im Y-m-d H:i Format.
maintenance_end_at
optional string
Wartungsenddatum im Y-m-d H:i Format.
alerts[index][key]
optional string
Alarm. Mögliche Werte sind: email für Email, webhook für Webhook, slack für Slack, teams für Microsoft Teams, discord für Discord, flock für Flock, sms für SMS.
alerts[index][value]
optional string
Wert des Alarms.
Aktualisieren

API-Endpunkt:

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

Anfragebeispiel: 

curl --location --request PUT 'https://uptimeworld.com/api/v1/monitors/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'
Parameter
Typ
Beschreibung
name
optional string
Name.
url
optional string
URL.
interval
optional integer
Intervall. Mögliche Werte sind: 60, 180, 300, 600, 900, 1800, 3600.
ssl_alert_days
optional integer
Die Anzahl der Tage vor Ablauf des SSL-Zertifikats, um einen Alarm zu erhalten. Mögliche Werte sind: 0, 1, 2, 3, 7, 14, 30, 60.
maintenance_start_at
optional string
Wartungsbeginndatum im Y-m-d H:i Format.
maintenance_end_at
optional string
Wartungsenddatum im Y-m-d H:i Format.
alerts[index][key]
optional string
Alarm. Mögliche Werte sind: email für Email, webhook für Webhook, slack für Slack, teams für Microsoft Teams, discord für Discord, flock für Flock, sms für SMS.
alerts[index][value]
optional string
Wert des Alarms.
paused
optional boolean
Pausiert.
Löschen

API-Endpunkt:

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

Anfragebeispiel: 

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