HydraCore
API by router

Alerts

List Alerts

GET
/v1/alerts

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Query Parameters

severity?|

Filter by severity: critical, warning, info

alert_type?|

Filter by alert type

status?|

Filter: active (unresolved), acknowledged, resolved, all

page?Page

Page number

Range1 <= value
Default1
page_size?Page Size

Items per page

Range1 <= value <= 100
Default25

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
items*array<>
page*Page
page_size*Page Size
total*Total
Example Request
curl -X GET 'https://example.com/v1/alerts'
Example Response
{  "items": [    {      "acknowledged_at": "string",      "acknowledged_by": "string",      "alert_type": "string",      "created_at": "string",      "customer_id": "string",      "detail": {},      "id": "string",      "instance_id": "string",      "resolved_at": "string",      "severity": "string",      "title": "string"    }  ],  "page": 0,  "page_size": 0,  "total": 0}

Alerts Summary

GET
/v1/alerts/summary

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
critical?Critical
Default0
info?Info
Default0
total?Total
Default0
warning?Warning
Default0
Example Request
curl -X GET 'https://example.com/v1/alerts/summary'
Example Response
{  "critical": 0,  "info": 0,  "total": 0,  "warning": 0}
PATCH
/v1/alerts/{alert_id}/acknowledge

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

alert_id*Alert Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
acknowledged*Acknowledged
alert_id*Alert Id
Example Request
curl -X PATCH 'https://example.com/v1/alerts/497f6eca-6276-4993-bfeb-53cbbbba6f08/acknowledge'
Example Response
{  "acknowledged": true,  "alert_id": "string"}

Resolve Alert Endpoint

PATCH
/v1/alerts/{alert_id}/resolve

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

alert_id*Alert Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
acknowledged*Acknowledged
alert_id*Alert Id
Example Request
curl -X PATCH 'https://example.com/v1/alerts/497f6eca-6276-4993-bfeb-53cbbbba6f08/resolve'
Example Response
{  "acknowledged": true,  "alert_id": "string"}