Incidentes

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

Ejemplo de solicitud: 

curl --location --request GET 'https://www.statiq.me/api/v1/incidents' \
--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: monitor para Monitor, cause para Causa. Por defecto: url.
monitor_id
opcional string
ID del monitor.
status
opcional string
Estado. Los valores posibles son: unresolved para Sin resolver, acknowledged para Reconocido, resolved para Resuelto.
sort_by
opcional string
Ordenar por. Los valores posibles son: started_at para Fecha started, ended_at para Fecha ended. Por defecto: ended_at.
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/incidents/{id}

Ejemplo de solicitud: 

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

Endpoint de API:

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

Ejemplo de solicitud: 

curl --location --request POST 'https://www.statiq.me/api/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ámetro
Tipo
Descripción
monitor_id
requerido integer
ID del monitor.
started_at
requerido string
Inició en fecha con formato Y-m-dTH:i:s.
acknowledged_at
opcional string
Reconocido en fecha con formato Y-m-dTH:i:s.
ended_at
opcional string
Finalizó en fecha con formato Y-m-dTH:i:s.
cause
opcional string
Causa.
comment
opcional string
Comentario.
Actualizar

Endpoint de API:

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

Ejemplo de solicitud: 

curl --location --request PUT 'https://www.statiq.me/api/v1/incidents/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parámetro
Tipo
Descripción
acknowledged_at
opcional string
Reconocido en fecha con formato Y-m-dTH:i:s.
ended_at
opcional string
Finalizó en fecha con formato Y-m-dTH:i:s.
cause
opcional string
Causa.
comment
opcional string
Comentario.
Eliminar

Endpoint de API:

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

Ejemplo de solicitud: 

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