Monitores

Notas
Nivel experto
La clave API debe enviarse como token Bearer en el encabezado Authorization de la solicitud. Obtén tu clave API.
Lista

Endpoint de API:

GET 
https://www.statiq.me/api/v1/monitors

Ejemplo de solicitud: 

curl --location --request GET 'https://www.statiq.me/api/v1/monitors' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parámetro
Tipo
Descripción
search
opcional string
la search query.
search_by
opcional string
Buscar por. Los valores posibles son: name para Nombre, url para URL. Por defecto: name.
status_page_id
opcional integer
página de estado ID.
sort_by
opcional string
Ordenar por. Los valores posibles son: id para Fecha de creación, name para Nombre, url para URL. Por defecto: id.
sort
opcional string
Ordenar. Los valores posibles son: desc para Descendente, asc para Ascendente. Por defecto: desc.
per_page
opcional integer
Resultados por página. Los valores posibles son: 10, 25, 50, 100. Por defecto: 10.
Mostrar

Endpoint de API:

GET 
https://www.statiq.me/api/v1/monitors/{id}

Ejemplo de solicitud: 

curl --location --request GET 'https://www.statiq.me/api/v1/monitors/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Crear

Endpoint de API:

POST 
https://www.statiq.me/api/v1/monitors

Ejemplo de solicitud: 

curl --location --request POST 'https://www.statiq.me/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}'
Parámetro
Tipo
Descripción
name
requerido string
Nombre.
url
requerido string
URL.
interval
requerido integer
Intervalo. Los valores posibles son: 60, 180, 300, 600, 900, 1800, 3600.
alert_condition
opcional string
Condición de alerta. Los valores posibles son: url_unavailable para La URL deja de estar disponible, url_text para La respuesta de la URL contiene texto, url_no_text para La respuesta de la URL no contiene texto. Por defecto: url_unavailable.
alert_text_lookup
opcional string
Text para be looked-up para trigger alerts. Solo funciona con el campo alert_condition establecido en url_text, url_no_text.
request_method
opcional string
Request método. Los valores posibles son: GET, POST, HEAD, PUT, DELETE, PATCH, OPTIONS, PING. Por defecto: GET.
request_headers[index][key]
opcional string
Nombre del encabezado de solicitud.
request_headers[index][value]
opcional string
Valor del encabezado de solicitud.
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
Anti-caché. Los valores posibles son: 0 para Deshabilitado, 1 para Habilitado. Por defecto: 0.
ssl_alert_days
opcional integer
The number of días before SSL certificate expiration to receive an alert. Los valores posibles son: 0, 1, 2, 3, 7, 14, 30, 60.
domain_alert_days
opcional integer
The number of días before domain name expiration to receive an alert. Los valores posibles son: 0, 1, 2, 3, 7, 14, 30, 60.
maintenance_start_at
opcional string
Fecha de inicio del mantenimiento en formato Y-m-dTH:i:s.
maintenance_end_at
opcional string
Fecha de fin del mantenimiento en formato Y-m-dTH:i:s.
alerts[index][key]
opcional string
Canales de alerta. Los valores posibles son: email para Email, webhook para Webhook, slack para Slack, teams para Microsoft Teams, discord para Discord, flock para Flock, telegram para Telegram, sms para SMS.
alerts[index][value]
opcional string
Value of la alert.
Actualizar

Endpoint de API:

PUT PATCH 
https://www.statiq.me/api/v1/monitors/{id}

Ejemplo de solicitud: 

curl --location --request PUT 'https://www.statiq.me/api/v1/monitors/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parámetro
Tipo
Descripción
name
opcional string
Nombre.
url
opcional string
URL.
interval
opcional integer
Intervalo. Los valores posibles son: 60, 180, 300, 600, 900, 1800, 3600.
alert_condition
opcional string
Condición de alerta. Los valores posibles son: url_unavailable para La URL deja de estar disponible, url_text para La respuesta de la URL contiene texto, url_no_text para La respuesta de la URL no contiene texto. Por defecto: url_unavailable.
alert_text_lookup
opcional string
Text para be looked-up para trigger alerts. Solo funciona con el campo alert_condition establecido en url_text, url_no_text.
request_method
opcional string
Request método. Los valores posibles son: GET, POST, HEAD, PUT, DELETE, PATCH, OPTIONS, PING. Por defecto: GET.
request_headers[index][key]
opcional string
Nombre del encabezado de solicitud.
request_headers[index][value]
opcional string
Valor del encabezado de solicitud.
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
Anti-caché. Los valores posibles son: 0 para Deshabilitado, 1 para Habilitado.
ssl_alert_days
opcional integer
The number of días before SSL certificate expiration to receive an alert. Los valores posibles son: 0, 1, 2, 3, 7, 14, 30, 60.
domain_alert_days
opcional integer
The number of días before domain name expiration to receive an alert. Los valores posibles son: 0, 1, 2, 3, 7, 14, 30, 60.
maintenance_start_at
opcional string
Fecha de inicio del mantenimiento en formato Y-m-dTH:i:s.
maintenance_end_at
opcional string
Fecha de fin del mantenimiento en formato Y-m-dTH:i:s.
alerts[index][key]
opcional string
Canales de alerta. Los valores posibles son: email para Email, webhook para Webhook, slack para Slack, teams para Microsoft Teams, discord para Discord, flock para Flock, telegram para Telegram, sms para SMS.
alerts[index][value]
opcional string
Value of la alert.
pause
opcional boolean
Pausar.
Eliminar

Endpoint de API:

DELETE 
https://www.statiq.me/api/v1/monitors/{id}

Ejemplo de solicitud: 

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