馃憠 Comen莽a gratis avui: supervisa la teva web, consulta estad铆stiques i rep alertes immediates.

Monitors

Notes
Nivell expert
La clau API s'ha d'enviar com un token Bearer a la cap莽alera Authorization de la petici贸. Obt茅n la teva clau API.
Llista

Extrem de API:

GET 
https://pingweb.cat/api/v1/monitors

Exemple de petici贸: 

curl --location --request GET 'https://pingweb.cat/api/v1/monitors' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Par脿metre
Tipus
Descripci贸
search
opcional string
La consulta de cerca.
search_by
opcional string
Cerca per. Els valors possibles s贸n: name per Nom, url per URL. Per defecte: name.
status_page_id
opcional integer
ID de la p脿gina d'estat.
sort_by
opcional string
Ordena per. Els valors possibles s贸n: id per Data de creaci贸, name per Nom, url per URL. Per defecte: id.
sort
opcional string
Ordena. Els valors possibles s贸n: desc per Descendent, asc per Ascendent. Per defecte: desc.
per_page
opcional integer
Resultats per p脿gina. Els valors possibles s贸n: 10, 25, 50, 100. Per defecte: 10.
Mostra

Extrem de API:

GET 
https://pingweb.cat/api/v1/monitors/{id}

Exemple de petici贸: 

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

Extrem de API:

POST 
https://pingweb.cat/api/v1/monitors

Exemple de petici贸: 

curl --location --request POST 'https://pingweb.cat/api/v1/monitors' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'url={url}'
Par脿metre
Tipus
Descripci贸
name
obligatori string
Nom.
url
obligatori string
URL.
interval
obligatori integer
Interval. Els valors possibles s贸n: 60, 180, 300, 600, 900, 1800, 3600.
alert_condition
obligatori string
Condici贸 d'alerta. Els valors possibles s贸n: url_unavailable per L'URL deixa d'estar disponible, url_text per La resposta de l'URL cont茅 text, url_no_text per La resposta de l'URL no cont茅 text.
alert_text_lookup
opcional string
Text a cercar per activar alertes. Nom茅s funciona amb el camp alert_condition establert a url_text, url_no_text.
request_method
obligatori string
M猫tode de petici贸. Els valors possibles s贸n: GET, POST, HEAD, PUT, DELETE, PATCH, OPTIONS.
request_headers[index][key]
opcional string
Nom de la cap莽alera de la petici贸.
request_headers[index][value]
opcional string
Valor de la cap莽alera de la petici贸.
request_auth_username
opcional string
Username for Basic HTTP request authentication.
request_auth_password
opcional string
Password for Basic HTTP request authentication.
cache_buster
opcional integer
Evitador de mem貌ria cau. Els valors possibles s贸n: 0 per Desactivat, 1 per Habilitat. Per defecte: 0.
ssl_alert_days
opcional integer
El nombre de dies abans de la caducitat del certificat SSL per rebre una alerta. Els valors possibles s贸n: 0, 1, 2, 3, 7, 14, 30, 60.
domain_alert_days
opcional integer
El nombre de dies abans de la caducitat del domini per rebre una alerta. Els valors possibles s贸n: 0, 1, 2, 3, 7, 14, 30, 60.
maintenance_start_at
opcional string
Data d'inici del manteniment en format Y-m-d H:i.
maintenance_end_at
opcional string
Data de finalitzaci贸 del manteniment en format Y-m-d H:i.
alerts[index][key]
opcional string
Canals d'alerta. Els valors possibles s贸n: email per Email, webhook per Webhook, slack per Slack, teams per Microsoft Teams, discord per Discord, flock per Flock, telegram per Telegram, sms per SMS.
alerts[index][value]
opcional string
Valor de l'alerta.
Actualitza

Extrem de API:

PUT PATCH 
https://pingweb.cat/api/v1/monitors/{id}

Exemple de petici贸: 

curl --location --request PUT 'https://pingweb.cat/api/v1/monitors/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'
Par脿metre
Tipus
Descripci贸
name
opcional string
Nom.
url
opcional string
URL.
interval
opcional integer
Interval. Els valors possibles s贸n: 60, 180, 300, 600, 900, 1800, 3600.
alert_condition
opcional string
Condici贸 d'alerta. Els valors possibles s贸n: url_unavailable per L'URL deixa d'estar disponible, url_text per La resposta de l'URL cont茅 text, url_no_text per La resposta de l'URL no cont茅 text.
alert_text_lookup
opcional string
Text a cercar per activar alertes. Nom茅s funciona amb el camp alert_condition establert a url_text, url_no_text.
request_method
opcional string
M猫tode de petici贸. Els valors possibles s贸n: GET, POST, HEAD, PUT, DELETE, PATCH, OPTIONS.
request_headers[index][key]
opcional string
Nom de la cap莽alera de la petici贸.
request_headers[index][value]
opcional string
Valor de la cap莽alera de la petici贸.
request_auth_username
opcional string
Username for Basic HTTP request authentication.
request_auth_password
opcional string
Password for Basic HTTP request authentication.
cache_buster
opcional integer
Evitador de mem貌ria cau. Els valors possibles s贸n: 0 per Desactivat, 1 per Habilitat.
ssl_alert_days
opcional integer
El nombre de dies abans de la caducitat del certificat SSL per rebre una alerta. Els valors possibles s贸n: 0, 1, 2, 3, 7, 14, 30, 60.
domain_alert_days
opcional integer
El nombre de dies abans de la caducitat del domini per rebre una alerta. Els valors possibles s贸n: 0, 1, 2, 3, 7, 14, 30, 60.
maintenance_start_at
opcional string
Data d'inici del manteniment en format Y-m-d H:i.
maintenance_end_at
opcional string
Data de finalitzaci贸 del manteniment en format Y-m-d H:i.
alerts[index][key]
opcional string
Canals d'alerta. Els valors possibles s贸n: email per Email, webhook per Webhook, slack per Slack, teams per Microsoft Teams, discord per Discord, flock per Flock, telegram per Telegram, sms per SMS.
alerts[index][value]
opcional string
Valor de l'alerta.
paused
opcional boolean
En pausa.
Elimina

Extrem de API:

DELETE 
https://pingweb.cat/api/v1/monitors/{id}

Exemple de petici贸: 

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