Alerts API

Describes the alerts API.

The Alerts API provides endpoints for retrieving and deleting alerts. Alerts can optionally be generated when a filter strategy's condition is met. See Alerts for more information on Philter alerts.

The curl example commands shown on this page are written assuming Philter has been enabled for SSL. If launched from a cloud marketplace, SSL will be enabled automatically with a self-signed SSL certificate. The example commands also assume API authentication is disabled. See the Settings for more information on SSL and API authentication.

get
Retrieve All Alerts

https://philter:8080/api/alerts
This method retrieves all alerts that have been generated in response to a filter condition being met. There are no request parameters.
Request
Response
Request
Response
200: OK
The response is an array of alert objects. The date property of an alert will be formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.
[
{
"id": "598a514e-76ef-492a-be7d-447e83026124",
"filterProfile": "my-filter-profile",
"strategyId": "my-strategy",
"context": "context",
"documentId": "documentId",
"filterType": "credit-card",
"date": "2020-05-27T13:57:47.016Z"
}
]

Example request:

curl -k https://localhost:8080/api/alerts

delete
Delete an Alert

https://philter:8080/api/alerts/{alertId}
This method deletes a single alert.
Request
Response
Request
Path Parameters
alertId
optional
string
The ID of the alert to delete.
Response
200: OK
There is no response body.

Example request to delete an alert with id 12345:

curl -k -X DELETE https://localhost:8080/api/alerts/12345