Monitory

Poznámky
Expertní úroveň
API klíč by měl být odeslán jako Bearer token v Authorization hlavičce požadavku. Získat API klíč.
Seznam

API endpoint:

GET 
https://siteuptimes.com/api/v1/monitors

Příklad požadavku: 

curl --location --request GET 'https://siteuptimes.com/api/v1/monitors' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parametr
Typ
Popis
search
nepovinné string
Vyhledávací dotaz.
search_by
nepovinné string
Hledat podle. Možné hodnoty jsou: name pro Jméno, url pro URL. Výchozí hodnota: name.
status_page_id
nepovinné integer
ID stavové stránky.
sort_by
nepovinné string
Seřadit podle. Možné hodnoty jsou: id pro Datum vytvoření, name pro Jméno, url pro URL. Výchozí hodnota: id.
sort
nepovinné string
Řadit. Možné hodnoty jsou: desc pro Sestupně, asc pro Vzestupně. Výchozí hodnota: desc.
per_page
nepovinné integer
Výsledků na stránku. Možné hodnoty jsou: 10, 25, 50, 100. Výchozí hodnota: 25.
Zobrazit

API endpoint:

GET 
https://siteuptimes.com/api/v1/monitors/{id}

Příklad požadavku: 

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

API endpoint:

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

Příklad požadavku: 

curl --location --request POST 'https://siteuptimes.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}'
Parametr
Typ
Popis
name
povinné string
Jméno.
url
povinné string
URL.
interval
povinné integer
Interval. Možné hodnoty jsou: 60, 180, 300, 600, 900, 1800, 3600.
alert_condition
povinné string
Podmínka upozornění. Možné hodnoty jsou: url_unavailable pro URL se stane nedostupnou, url_text pro Odpověď URL obsahuje text, url_no_text pro Odpověď URL neobsahuje text.
alert_text_lookup
nepovinné string
Text, který se má hledat pro spuštění upozornění. Funguje pouze s polem alert_condition nastaveným na url_text, url_no_text.
request_method
povinné string
Metoda požadavku. Možné hodnoty jsou: GET, POST, HEAD, PUT, DELETE, PATCH, OPTIONS.
request_headers[index][key]
nepovinné string
Název hlavičky požadavku.
request_headers[index][value]
nepovinné string
Hodnota hlavičky požadavku.
request_auth_username
nepovinné string
Username for Basic HTTP request authentication.
request_auth_password
nepovinné string
Password for Basic HTTP request authentication.
cache_buster
nepovinné integer
Obejití cache. Možné hodnoty jsou: 0 pro Zakázáno, 1 pro Povoleno. Výchozí hodnota: 0.
ssl_alert_days
nepovinné integer
Počet dní před vypršením SSL certifikátu pro obdržení upozornění. Možné hodnoty jsou: 0, 1, 2, 3, 7, 14, 30, 60.
domain_alert_days
nepovinné integer
Počet dní před vypršením doménového jména pro obdržení upozornění. Možné hodnoty jsou: 0, 1, 2, 3, 7, 14, 30, 60.
maintenance_start_at
nepovinné string
Datum začátku údržby ve formátu Y-m-d H:i.
maintenance_end_at
nepovinné string
Datum konce údržby ve formátu Y-m-d H:i.
alerts[index][key]
nepovinné string
Kanály upozornění. Možné hodnoty jsou: email pro Email, webhook pro Webhook, slack pro Slack, teams pro Microsoft Teams, discord pro Discord, flock pro Flock, sms pro SMS.
alerts[index][value]
nepovinné string
Hodnota výstrahy.
Aktualizovat

API endpoint:

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

Příklad požadavku: 

curl --location --request PUT 'https://siteuptimes.com/api/v1/monitors/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'
Parametr
Typ
Popis
name
nepovinné string
Jméno.
url
nepovinné string
URL.
interval
nepovinné integer
Interval. Možné hodnoty jsou: 60, 180, 300, 600, 900, 1800, 3600.
alert_condition
nepovinné string
Podmínka upozornění. Možné hodnoty jsou: url_unavailable pro URL se stane nedostupnou, url_text pro Odpověď URL obsahuje text, url_no_text pro Odpověď URL neobsahuje text.
alert_text_lookup
nepovinné string
Text, který se má hledat pro spuštění upozornění. Funguje pouze s polem alert_condition nastaveným na url_text, url_no_text.
request_method
nepovinné string
Metoda požadavku. Možné hodnoty jsou: GET, POST, HEAD, PUT, DELETE, PATCH, OPTIONS.
request_headers[index][key]
nepovinné string
Název hlavičky požadavku.
request_headers[index][value]
nepovinné string
Hodnota hlavičky požadavku.
request_auth_username
nepovinné string
Username for Basic HTTP request authentication.
request_auth_password
nepovinné string
Password for Basic HTTP request authentication.
cache_buster
nepovinné integer
Obejití cache. Možné hodnoty jsou: 0 pro Zakázáno, 1 pro Povoleno.
ssl_alert_days
nepovinné integer
Počet dní před vypršením SSL certifikátu pro obdržení upozornění. Možné hodnoty jsou: 0, 1, 2, 3, 7, 14, 30, 60.
domain_alert_days
nepovinné integer
Počet dní před vypršením doménového jména pro obdržení upozornění. Možné hodnoty jsou: 0, 1, 2, 3, 7, 14, 30, 60.
maintenance_start_at
nepovinné string
Datum začátku údržby ve formátu Y-m-d H:i.
maintenance_end_at
nepovinné string
Datum konce údržby ve formátu Y-m-d H:i.
alerts[index][key]
nepovinné string
Kanály upozornění. Možné hodnoty jsou: email pro Email, webhook pro Webhook, slack pro Slack, teams pro Microsoft Teams, discord pro Discord, flock pro Flock, sms pro SMS.
alerts[index][value]
nepovinné string
Hodnota výstrahy.
paused
nepovinné boolean
Pozastaveno.
Smazat

API endpoint:

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

Příklad požadavku: 

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