Monitoring stron

Uwagi
Poziom ekspercki
Klucz API powinien zostać wysłany jako token Bearer w nagłówku Authorization żądania. Uzyskaj klucz API.
Lista

Punkt końcowy API:

GET 
https://evalo.pl/api/v1/monitors

Przykład żądania: 

curl --location --request GET 'https://evalo.pl/api/v1/monitors' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parametr
Typ
Opis
search
opcjonalnie string
Zapytanie wyszukiwania.
search_by
opcjonalnie string
Szukaj według. Możliwe wartości to: name dla Nazwa, url dla URL. Domyślnie: name.
status_page_id
opcjonalnie integer
Identyfikator strony stanu.
sort_by
opcjonalnie string
Sortuj według. Możliwe wartości to: id dla Data utworzenia, name dla Nazwa, url dla URL. Domyślnie: id.
sort
opcjonalnie string
Sortuj. Możliwe wartości to: desc dla Schodzenie, asc dla Rosnąco. Domyślnie: desc.
per_page
opcjonalnie integer
Wyniki na stronę. Możliwe wartości to: 10, 25, 50, 100. Domyślnie: 10.
Pokaż

Punkt końcowy API:

GET 
https://evalo.pl/api/v1/monitors/{id}

Przykład żądania: 

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

Punkt końcowy API:

POST 
https://evalo.pl/api/v1/monitors

Przykład żądania: 

curl --location --request POST 'https://evalo.pl/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}'
Parametr
Typ
Opis
name
wymagane string
Nazwa.
url
wymagane string
URL.
interval
wymagane integer
Częstotoliwość. Możliwe wartości to: 60, 180, 300, 600, 900, 1800, 3600.
alert_condition
opcjonalnie string
Warunek powiadomień. Możliwe wartości to: url_unavailable dla Adres URL staje się niedostępny, url_text dla Odpowiedź z URL zawiera tekst, url_no_text dla Odpowiedź z URL nie zawiera tekstu. Domyślnie: url_unavailable.
alert_text_lookup
opcjonalnie string
Text to be looked-up to trigger alerts. Działa tylko z polem alert_condition ustawionym na url_text, url_no_text.
request_method
opcjonalnie string
Metoda żądania. Możliwe wartości to: GET, POST, HEAD, PUT, DELETE, PATCH, OPTIONS. Domyślnie: GET.
request_headers[index][key]
opcjonalnie string
Nazwa nagłówka żądania.
request_headers[index][value]
opcjonalnie string
Wartość nagłówka żądania.
request_auth_username
opcjonalnie string
Username for Basic HTTP request authentication.
request_auth_password
opcjonalnie string
Password for Basic HTTP request authentication.
cache_buster
opcjonalnie integer
Cache buster. Możliwe wartości to: 0 dla Wyłączony, 1 dla Włączone. Domyślnie: 0.
ssl_alert_days
opcjonalnie integer
Liczba dni przed wygaśnięciem certyfikatu SSL, aby otrzymać alert. Możliwe wartości to: 0, 1, 2, 3, 7, 14, 30, 60.
domain_alert_days
opcjonalnie integer
Liczba dni przed wygaśnięciem nazwy domeny, aby otrzymać powiadomienie. Możliwe wartości to: 0, 1, 2, 3, 7, 14, 30, 60.
maintenance_start_at
opcjonalnie string
Data rozpoczęcia konserwacji w formacie Y-m-dTH:i:s.
maintenance_end_at
opcjonalnie string
Data zakończenia konserwacji w formacie Y-m-dTH:i:s.
alerts[index][key]
opcjonalnie string
Kanały powiadomień. Możliwe wartości to: email dla Email, webhook dla Webhook, slack dla Slack, teams dla Microsoft Teams, discord dla Discord, flock dla Flock, telegram dla Telegram, sms dla SMS.
alerts[index][value]
opcjonalnie string
Wartość alertu.
Aktualizacja

Punkt końcowy API:

PUT PATCH 
https://evalo.pl/api/v1/monitors/{id}

Przykład żądania: 

curl --location --request PUT 'https://evalo.pl/api/v1/monitors/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parametr
Typ
Opis
name
opcjonalnie string
Nazwa.
url
opcjonalnie string
URL.
interval
opcjonalnie integer
Częstotoliwość. Możliwe wartości to: 60, 180, 300, 600, 900, 1800, 3600.
alert_condition
opcjonalnie string
Warunek powiadomień. Możliwe wartości to: url_unavailable dla Adres URL staje się niedostępny, url_text dla Odpowiedź z URL zawiera tekst, url_no_text dla Odpowiedź z URL nie zawiera tekstu. Domyślnie: url_unavailable.
alert_text_lookup
opcjonalnie string
Text to be looked-up to trigger alerts. Działa tylko z polem alert_condition ustawionym na url_text, url_no_text.
request_method
opcjonalnie string
Metoda żądania. Możliwe wartości to: GET, POST, HEAD, PUT, DELETE, PATCH, OPTIONS. Domyślnie: GET.
request_headers[index][key]
opcjonalnie string
Nazwa nagłówka żądania.
request_headers[index][value]
opcjonalnie string
Wartość nagłówka żądania.
request_auth_username
opcjonalnie string
Username for Basic HTTP request authentication.
request_auth_password
opcjonalnie string
Password for Basic HTTP request authentication.
cache_buster
opcjonalnie integer
Cache buster. Możliwe wartości to: 0 dla Wyłączony, 1 dla Włączone.
ssl_alert_days
opcjonalnie integer
Liczba dni przed wygaśnięciem certyfikatu SSL, aby otrzymać alert. Możliwe wartości to: 0, 1, 2, 3, 7, 14, 30, 60.
domain_alert_days
opcjonalnie integer
Liczba dni przed wygaśnięciem nazwy domeny, aby otrzymać powiadomienie. Możliwe wartości to: 0, 1, 2, 3, 7, 14, 30, 60.
maintenance_start_at
opcjonalnie string
Data rozpoczęcia konserwacji w formacie Y-m-dTH:i:s.
maintenance_end_at
opcjonalnie string
Data zakończenia konserwacji w formacie Y-m-dTH:i:s.
alerts[index][key]
opcjonalnie string
Kanały powiadomień. Możliwe wartości to: email dla Email, webhook dla Webhook, slack dla Slack, teams dla Microsoft Teams, discord dla Discord, flock dla Flock, telegram dla Telegram, sms dla SMS.
alerts[index][value]
opcjonalnie string
Wartość alertu.
pause
opcjonalnie boolean
Pauza.
Usuń

Punkt końcowy API:

DELETE 
https://evalo.pl/api/v1/monitors/{id}

Przykład żądania: 

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