Incidents

GET https://uptimeape.com/api/incidents/
curl --request GET \
--url 'https://uptimeape.com/api/incidents/' \
--header 'Authorization: Bearer {api_key}' \
Parâmetros Detalhes Descrição
search Opcional String A string de busca.
search_by Opcional String Qual campo você está pesquisando? Os valores permitidos são: comment.
order_by Opcional String Qual campo ordenar os resultados. Os valores permitidos são: incident_id , start_datetime , end_datetime , last_failed_check_datetime , failed_checks.
order_type Opcional String A ordenação dos resultados. Os valores permitidos são: ASC para ordenação ascendente e DESC para ordenação descendente.
page Opcional Inteiro O número da página de onde você deseja os resultados. O padrão é 1.
results_per_page Opcional Inteiro Quantos resultados você deseja por página. Os valores permitidos são: 10 , 25 , 50 , 100 , 250 , 500 , 1000. O padrão é 25.
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "monitor_id": 0,
            "start_monitor_log_id": 0,
            "end_monitor_log_id": 0,
            "heartbeat_id": 13,
            "start_heartbeat_log_id": 264,
            "end_heartbeat_log_id": 0,
            "start_datetime": "2026-05-31 12:49:28",
            "end_datetime": null,
            "last_failed_check_datetime": null,
            "failed_checks": 5,
            "notification_handlers_ids": [1,2,3],
            "comment": null
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://uptimeape.com/api/incidents?page=1",
        "last": "https://uptimeape.com/api/incidents?page=1",
        "next": null,
        "prev": null,
        "self": "https://uptimeape.com/api/incidents?page=1"
    }
}
GET https://uptimeape.com/api/incidents/{incident_id}
curl --request GET \
--url 'https://uptimeape.com/api/incidents/{incident_id}' \
--header 'Authorization: Bearer {api_key}' \
{
    "data": {
        "id": 1,
        "user_id": 1,
        "monitor_id": 0,
        "start_monitor_log_id": 0,
        "end_monitor_log_id": 0,
        "heartbeat_id": 13,
        "start_heartbeat_log_id": 264,
        "end_heartbeat_log_id": 0,
        "start_datetime": "2026-05-31 12:49:28",
        "end_datetime": null,
        "last_failed_check_datetime": null,
        "failed_checks": 5,
        "notification_handlers_ids": [1,2,3],
        "comment": null
    }
}
POST https://uptimeape.com/api/incidents/{incident_id}
Parâmetros Detalhes Descrição
comment Opcional String -
curl --request POST \
--url 'https://uptimeape.com/api/incidents/{incident_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'comment=Example' \
{
    "data": {
        "id": 1
    }
}
DELETE https://uptimeape.com/api/incidents/{incident_id}
curl --request DELETE \
--url 'https://uptimeape.com/api/incidents/{incident_id}' \
--header 'Authorization: Bearer {api_key}' \