Monitores

Autenticación

La clave de API se envía como token Bearer en la cabecera Authorization de la petición. Obtén tu clave de API.

Listar

Dirección de la API

GET

https://api.monitoraweb.com/v1/monitors

Ejemplo de petición

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

Parámetros

Nombre

Tipo

Descripción

search

opcional string

El texto de búsqueda.

search_by

opcional string

Buscar por. Valores posibles: name para Nombre, url para URL. Por omisión: name.

host

opcional string

Nombre exacto del host, con o sin www. Ejemplo: ejemplo.com.

status_page_id

opcional integer

ID de la página de estado.

sort_by

opcional string

Ordenar por. Valores posibles: id para Fecha de creación, name para Nombre, url para URL. Por omisión: id.

sort

opcional string

Orden. Valores posibles: desc para Descendente, asc para Descendente. Por omisión: desc.

per_page

opcional integer

Resultados por página. Valores posibles: 10, 25, 50, 100. Por omisión: 10.

Ver

Dirección de la API

GET

https://api.monitoraweb.com/v1/monitors/{id}

Ejemplo de petición

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

Crear

Dirección de la API

POST

https://api.monitoraweb.com/v1/monitors

Ejemplo de petición

curl --location --request POST 'https://api.monitoraweb.com/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ámetros

Nombre

Tipo

Descripción

name

obligatorio string

Nombre.

url

obligatorio string

URL.

interval

obligatorio integer

Intervalo. Valores posibles: 60, 180, 300, 600, 900, 1800, 3600.

alert_condition

opcional string

Condición de alerta. Valores posibles: url_unavailable para La URL deja de estar disponible, url_text para La respuesta contiene el texto, url_no_text para La respuesta no contiene el texto. Por omisión: url_unavailable.

alert_text_lookup

opcional string

Texto que se busca para disparar las alertas. Solo funciona si el campo alert_condition vale url_text, url_no_text.

alert_channel_ids[]

opcional array

ID de los canales de alerta.

source

opcional string

Origen del monitor. Valores posibles: api, manual. Por omisión: api. También se acepta en la cabecera X-Source.

request_method

opcional string

Método de la petición. Valores posibles: GET, POST, HEAD, PUT, DELETE, PATCH, OPTIONS. Por omisión: GET.

request_headers[index][key]

opcional string

Nombre de la cabecera de la petición.

request_headers[index][value]

opcional string

Valor de la cabecera de la petición.

request_auth_username

opcional string

Usuario para la autenticación básica HTTP.

request_auth_password

opcional string

Contraseña para la autenticación básica HTTP.

cache_buster

opcional integer

Evitar caché. Valores posibles: 0 para Desactivado, 1 para Activado. Por omisión: 0.

ssl_alert_days

opcional integer

Días de antelación para avisar de la caducidad del certificado SSL. Valores posibles: 0, 1, 2, 3, 7, 14, 30, 60.

domain_alert_days

opcional integer

Días de antelación para avisar de la caducidad del dominio. Valores posibles: 0, 1, 2, 3, 7, 14, 30, 60.

maintenance_start_at

opcional string

Inicio del mantenimiento en formato Y-m-dTH:i:s.

maintenance_end_at

opcional string

Fin del mantenimiento en formato Y-m-dTH:i:s.

Actualizar

Dirección de la API

PUT PATCH

https://api.monitoraweb.com/v1/monitors/{id}

Ejemplo de petición

curl --location --request PUT 'https://api.monitoraweb.com/v1/monitors/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'

Parámetros

Nombre

Tipo

Descripción

name

opcional string

Nombre.

url

opcional string

URL.

interval

opcional integer

Intervalo. Valores posibles: 60, 180, 300, 600, 900, 1800, 3600.

alert_condition

opcional string

alert_text_lookup

opcional string

Texto que se busca para disparar las alertas. Solo funciona si el campo alert_condition vale url_text, url_no_text.

alert_channel_ids[]

opcional array

ID de los canales de alerta.

source

opcional string

Origen del monitor. Valores posibles: api, manual. Por omisión: api. También se acepta en la cabecera X-Source.

request_method

opcional string

Método de la petición. Valores posibles: GET, POST, HEAD, PUT, DELETE, PATCH, OPTIONS. Por omisión: GET.

request_headers[index][key]

opcional string

Nombre de la cabecera de la petición.

request_headers[index][value]

opcional string

Valor de la cabecera de la petición.

request_auth_username

opcional string

Usuario para la autenticación básica HTTP.

request_auth_password

opcional string

Contraseña para la autenticación básica HTTP.

cache_buster

opcional integer

Evitar caché. Valores posibles: 0 para Desactivado, 1 para Activado.

ssl_alert_days

opcional integer

Días de antelación para avisar de la caducidad del certificado SSL. Valores posibles: 0, 1, 2, 3, 7, 14, 30, 60.

domain_alert_days

opcional integer

Días de antelación para avisar de la caducidad del dominio. Valores posibles: 0, 1, 2, 3, 7, 14, 30, 60.

maintenance_start_at

opcional string

Inicio del mantenimiento en formato Y-m-dTH:i:s.

maintenance_end_at

opcional string

Fin del mantenimiento en formato Y-m-dTH:i:s.

pause

opcional boolean

Pausa el monitor sin borrarlo. Usa true / 1 para pausar (detiene las comprobaciones HTTP, SSL y de dominio, y los webhooks) y false / 0 para reanudar el mismo monitor. Se conserva el historial de incidentes y de comprobaciones.

Eliminar

Dirección de la API

DELETE

https://api.monitoraweb.com/v1/monitors/{id}

Ejemplo de petición

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