This URL is used to retrieve all alerts.
Resource URL
UPDATE /alerts? alertstate=<state> &timeperiod==<timeperiod> &startime==<start_time> &endtime=<end_time>& search=<search_strng>&filter=<filter_value>
Request Parameters
Query Parameters:
Field Name | Description | Data Type | Mandatory |
|---|---|---|---|
| Alert state, values allowed are, ANY/Acknowledged/Unacknowledged | String | No |
| Time period, allowed values are
| String | No |
| Start time | String | No |
| End time | String | No |
| Search | String | No |
| Filter on following column is allowed name, assignTo, application, layer7Data, result, attackCount, relevance, alertId, direction, device, domain, interface, attackSeverity, nspId, btp, attackCategory, malwarefileName, malwarefileHash, malwareName, malwareConfidence, malwareEngine ,executableName, executableHash, executableConfidenceName, attackerIPAddress, attackerPort, attackerRisk, attackerProxyIP, attackerHostname, targetIPAddress, targetPort, targetRisk, targetProxyIP, targetHostname, botnetFamily Ex: name:Malware;direction:Inbound,Outbound;attackcount:>3,<4 | String | No |
Payload parameters:
Field Name | Description | Data Type |
|---|---|---|
| Alert state | String |
| User id | String |
Response Parameters
Following fields are returned.
Field Name | Description | Data Type |
|---|---|---|
| Set to 1 if the operation was successful, -1 otherwise | Number |
Example
Request
{
"alertState": "Acknowledged",
"assignTo": "admin"
}Response
{
"status":1
}
Error Information
Following error codes are returned by this URL:
No | HTTP Error Code | SDK API errorId | SDK API errorMessage |
|---|---|---|---|
1 | 404 | 3704 | Invalid filter value |
2 | 404 | 9803 | Sensor id is required |
3 | 404 | 9803 | Manager name is required |