Incidentes

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/incidents

Ejemplo de petición

curl --location --request GET 'https://api.monitoraweb.com/v1/incidents' \
--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: monitor para Monitor, cause para Causa. Por omisión: url.
monitor_id
opcional string
ID del monitor.
status
opcional string
Estado. Valores posibles: unresolved para Sin resolver, acknowledged para Reconocido, resolved para Resuelto.
sort_by
opcional string
Ordenar por. Valores posibles: started_at para Fecha de inicio, ended_at para Fecha de fin. Por omisión: ended_at.
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/incidents/{id}

Ejemplo de petición

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

Dirección de la API

POST
https://api.monitoraweb.com/v1/incidents

Ejemplo de petición

curl --location --request POST 'https://api.monitoraweb.com/v1/incidents' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'monitor_id={monitor_id}' \
--data-urlencode 'started_at={started_at}'

Parámetros

Nombre
Tipo
Descripción
monitor_id
obligatorio integer
ID del monitor.
started_at
obligatorio string
Fecha de inicio en formato Y-m-dTH:i:s.
acknowledged_at
opcional string
Fecha en que se tomó nota, en formato Y-m-dTH:i:s.
ended_at
opcional string
Fecha de fin en formato Y-m-dTH:i:s.
cause
opcional string
Causa.
public_message
opcional string
Mensaje público.
internal_note
opcional string
Nota interna.
Actualizar

Dirección de la API

PUT PATCH
https://api.monitoraweb.com/v1/incidents/{id}

Ejemplo de petición

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

Parámetros

Nombre
Tipo
Descripción
acknowledged_at
opcional string
Fecha en que se tomó nota, en formato Y-m-dTH:i:s.
ended_at
opcional string
Fecha de fin en formato Y-m-dTH:i:s.
cause
opcional string
Causa.
public_message
opcional string
Mensaje público.
internal_note
opcional string
Nota interna.
Eliminar

Dirección de la API

DELETE
https://api.monitoraweb.com/v1/incidents/{id}

Ejemplo de petición

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