Statusseiten

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/status-pages

Anfragebeispiel: 

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

Anfragebeispiel: 

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

API-Endpunkt:

POST 
https://uptimeworld.com/api/v1/status-pages

Anfragebeispiel: 

curl --location --request POST 'https://uptimeworld.com/api/v1/status-pages' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={url}' \
--data-urlencode 'slug={id}'
Parameter
Typ
Beschreibung
name
erforderlich string
Name.
slug
erforderlich string
Slug.
monitor_ids[]
optional array
Monitor-IDs
privacy
optional integer
Datenschutz. Mögliche Werte sind: 0 für Öffentlich, 1 für Privat, 2 für Passwort. Standardmässig: 0.
password
optional string
Passwort. Funktioniert nur, wenn das Feld privacy auf 2 gesetzt ist.
domain
optional string
Eigene Domain.
logo
optional file
Logo.
favicon
optional file
Favicon.
remove_logo
optional boolean
Logo entfernen.
remove_favicon
optional boolean
Favicon entfernen.
website_url
optional string
Website-URL.
contact_url
optional string
Kontakt-URL.
custom_css
optional string
Benutzerdefiniertes CSS.
custom_js
optional string
Benutzerdefiniertes JS.
meta_title
optional string
Meta-Titel.
meta_description
optional string
Meta-Beschreibung.
noindex
optional boolean
Die Statusseite aus Suchmaschinen ausschliessen.
Aktualisieren

API-Endpunkt:

POST 
https://uptimeworld.com/api/v1/status-pages/{id}

Anfragebeispiel: 

curl --location --request POST 'https://uptimeworld.com/api/v1/status-pages/{id}' \
--header 'Authorization: Bearer {api_key}' \
--form '_method="PUT"'
Parameter
Typ
Beschreibung
_method
erforderlich string
Muss auf PUT gesetzt sein.
name
optional string
Name.
slug
optional string
Slug.
monitor_ids[]
optional array
Monitor-IDs
privacy
optional integer
Datenschutz. Mögliche Werte sind: 0 für Öffentlich, 1 für Privat, 2 für Passwort.
password
optional string
Passwort. Funktioniert nur, wenn das Feld privacy auf 2 gesetzt ist.
domain
optional string
Eigene Domain.
logo
optional file
Logo.
favicon
optional file
Favicon.
remove_logo
optional boolean
Logo entfernen.
remove_favicon
optional boolean
Favicon entfernen.
website_url
optional string
Website-URL.
contact_url
optional string
Kontakt-URL.
custom_css
optional string
Benutzerdefiniertes CSS.
custom_js
optional string
Benutzerdefiniertes JS.
meta_title
optional string
Meta-Titel.
meta_description
optional string
Meta-Beschreibung.
noindex
optional boolean
Die Statusseite aus Suchmaschinen ausschliessen.
Löschen

API-Endpunkt:

DELETE 
https://uptimeworld.com/api/v1/status-pages/{id}

Anfragebeispiel: 

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