Rules and Alerts

Rule engine APIs for alert rules

get

https://localhost:3000/apihttp://localhost:3000/api

/alerts/rules

Get all alert rules

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/alerts/rules

HTTPcURLJavaScriptPython

GET /api/alerts/rules HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/alerts/summary

Get summarized alerts for dashboard

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

startDatestringRequired

Start date (UTC) in YYYY-MM-DD HH:mm:ss

endDatestringRequired

End date (UTC) in YYYY-MM-DD HH:mm:ss

fabricidstringOptional

Fabric id or all_fabrics

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/alerts/summary

HTTPcURLJavaScriptPython

GET /api/alerts/summary?startDate=text&endDate=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/alerts/by-rule

Get alerts for a specific rule with pagination

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

startDatestringRequired

Start date (UTC) in YYYY-MM-DD HH:mm:ss

endDatestringRequired

End date (UTC) in YYYY-MM-DD HH:mm:ss

ruleNamestringRequired

Rule name

pagenumberRequired

Page number (0-based)

sizenumberRequired

Page size

showWarningOnlybooleanRequired

If true, returns warning-only alerts

fabricidstringOptional

Fabric id or all_fabrics

showArchivedOnlybooleanOptional

If true, returns archived alerts only

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/alerts/by-rule

HTTPcURLJavaScriptPython

GET /api/alerts/by-rule?startDate=text&endDate=text&ruleName=text&page=1&size=1&showWarningOnly=true HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/alerts/payload/{uuid}

Get alert payload by UUID

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Path parameters

uuidstringRequired

Alert UUID

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/alerts/payload/{uuid}

HTTPcURLJavaScriptPython

GET /api/alerts/payload/{uuid} HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content