Monitors

Opmerkingen
Expert-niveau
De API-sleutel moet als Bearer-token in de Authorization-header van het verzoek worden meegestuurd. Haal uw API-sleutel op.
Lijst

API-endpoint:

GET 
https://upsio.nl/api/v1/monitors

Voorbeeldverzoek: 

curl --location --request GET 'https://upsio.nl/api/v1/monitors' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Beschrijving
search
optioneel string
De zoekopdracht.
search_by
optioneel string
Zoeken op. Mogelijke waarden zijn: name voor Naam, url voor URL. Standaardwaarde: name.
status_page_id
optioneel integer
Statuspagina-ID.
sort_by
optioneel string
Sorteren op. Mogelijke waarden zijn: id voor Aanmaakdatum, name voor Naam, url voor URL. Standaardwaarde: id.
sort
optioneel string
Sorteren. Mogelijke waarden zijn: desc voor Aflopend, asc voor Oplopend. Standaardwaarde: desc.
per_page
optioneel integer
Resultaten per pagina. Mogelijke waarden zijn: 10, 25, 50, 100. Standaardwaarde: 10.
Tonen

API-endpoint:

GET 
https://upsio.nl/api/v1/monitors/{id}

Voorbeeldverzoek: 

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

API-endpoint:

POST 
https://upsio.nl/api/v1/monitors

Voorbeeldverzoek: 

curl --location --request POST 'https://upsio.nl/api/v1/monitors' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'url={url}' \
--data-urlencode 'interval={interval}'
Parameter
Type
Beschrijving
name
verplicht string
Naam.
url
verplicht string
URL.
interval
verplicht integer
Interval. Mogelijke waarden zijn: 60, 180, 300, 600, 900, 1800, 3600.
alert_condition
optioneel string
Waarschuwingsvoorwaarde. Mogelijke waarden zijn: url_unavailable voor URL wordt onbereikbaar, url_text voor URL-antwoord bevat tekst, url_no_text voor URL-antwoord bevat geen tekst. Standaardwaarde: url_unavailable.
alert_text_lookup
optioneel string
Tekst waarnaar moet worden gezocht om waarschuwingen te activeren. Werkt alleen wanneer het veld alert_condition is ingesteld op url_text, url_no_text.
request_method
optioneel string
Requestmethode. Mogelijke waarden zijn: GET, POST, HEAD, PUT, DELETE, PATCH, OPTIONS. Standaardwaarde: GET.
request_headers[index][key]
optioneel string
Naam van de request-header.
request_headers[index][value]
optioneel string
Waarde van de request-header.
request_auth_username
optioneel string
Username for Basic HTTP request authentication.
request_auth_password
optioneel string
Password for Basic HTTP request authentication.
cache_buster
optioneel integer
Cache-buster. Mogelijke waarden zijn: 0 voor Uitgeschakeld, 1 voor Ingeschakeld. Standaardwaarde: 0.
ssl_alert_days
optioneel integer
Het aantal dagen voor het verlopen van het SSL-certificaat om een waarschuwing te ontvangen. Mogelijke waarden zijn: 0, 1, 2, 3, 7, 14, 30, 60.
domain_alert_days
optioneel integer
Het aantal dagen voor het verlopen van de domeinnaam om een waarschuwing te ontvangen. Mogelijke waarden zijn: 0, 1, 2, 3, 7, 14, 30, 60.
maintenance_start_at
optioneel string
Startdatum van onderhoud in het formaat Y-m-dTH:i:s.
maintenance_end_at
optioneel string
Einddatum van onderhoud in het formaat Y-m-dTH:i:s.
alerts[index][key]
optioneel string
Waarschuwingskanalen. Mogelijke waarden zijn: email voor Email, webhook voor Webhook, slack voor Slack, teams voor Microsoft Teams, discord voor Discord, flock voor Flock, telegram voor Telegram, sms voor SMS.
alerts[index][value]
optioneel string
Waarde van de waarschuwing.
Bijwerken

API-endpoint:

PUT PATCH 
https://upsio.nl/api/v1/monitors/{id}

Voorbeeldverzoek: 

curl --location --request PUT 'https://upsio.nl/api/v1/monitors/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Beschrijving
name
optioneel string
Naam.
url
optioneel string
URL.
interval
optioneel integer
Interval. Mogelijke waarden zijn: 60, 180, 300, 600, 900, 1800, 3600.
alert_condition
optioneel string
Waarschuwingsvoorwaarde. Mogelijke waarden zijn: url_unavailable voor URL wordt onbereikbaar, url_text voor URL-antwoord bevat tekst, url_no_text voor URL-antwoord bevat geen tekst. Standaardwaarde: url_unavailable.
alert_text_lookup
optioneel string
Tekst waarnaar moet worden gezocht om waarschuwingen te activeren. Werkt alleen wanneer het veld alert_condition is ingesteld op url_text, url_no_text.
request_method
optioneel string
Requestmethode. Mogelijke waarden zijn: GET, POST, HEAD, PUT, DELETE, PATCH, OPTIONS. Standaardwaarde: GET.
request_headers[index][key]
optioneel string
Naam van de request-header.
request_headers[index][value]
optioneel string
Waarde van de request-header.
request_auth_username
optioneel string
Username for Basic HTTP request authentication.
request_auth_password
optioneel string
Password for Basic HTTP request authentication.
cache_buster
optioneel integer
Cache-buster. Mogelijke waarden zijn: 0 voor Uitgeschakeld, 1 voor Ingeschakeld.
ssl_alert_days
optioneel integer
Het aantal dagen voor het verlopen van het SSL-certificaat om een waarschuwing te ontvangen. Mogelijke waarden zijn: 0, 1, 2, 3, 7, 14, 30, 60.
domain_alert_days
optioneel integer
Het aantal dagen voor het verlopen van de domeinnaam om een waarschuwing te ontvangen. Mogelijke waarden zijn: 0, 1, 2, 3, 7, 14, 30, 60.
maintenance_start_at
optioneel string
Startdatum van onderhoud in het formaat Y-m-dTH:i:s.
maintenance_end_at
optioneel string
Einddatum van onderhoud in het formaat Y-m-dTH:i:s.
alerts[index][key]
optioneel string
Waarschuwingskanalen. Mogelijke waarden zijn: email voor Email, webhook voor Webhook, slack voor Slack, teams voor Microsoft Teams, discord voor Discord, flock voor Flock, telegram voor Telegram, sms voor SMS.
alerts[index][value]
optioneel string
Waarde van de waarschuwing.
pause
optioneel boolean
Pauzeren.
Verwijderen

API-endpoint:

DELETE 
https://upsio.nl/api/v1/monitors/{id}

Voorbeeldverzoek: 

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