Get /policy/security-alarm
Description
Returns a list of Security Alarm records matching the supplied filter.
Request Headers
|
Key |
Value |
Type |
Description |
|---|---|---|---|
| Authorization | Bearer <Authorization Token> | String | Authorization credential generated by FortiNAC |
| Content-Type (option 1) | application/json | String | |
|
Content-Type (option 2) |
application/xml |
|
|
Request Body Parameters
|
Name |
Required |
Type |
|---|---|---|
| filter | Optional | Array |
| start | Optional | Integer |
| count | Optional | Integer |
| sortKey | Optional | String |
| sortDir | Optional | String |
Sample Request
|
Request URL |
Get https://10.106.94.152:8443/api/v2/policy/security-alarm |
| Request Header |
Authorization: Bearer <Authorization_Token> Content-Type: application/json
|
Sample Response
{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"hostID": 0,
"hostMac": "string",
"eventDate": "2024-01-31T19:25:00.752Z",
"ruleText": "string",
"actionText": "string",
"eventAction": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-31T19:25:00.752Z",
"dbid": 0,
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-01-31T19:25:00.752Z",
"onFailure": "string",
"secondaryActionTimer": 0,
"activities": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"type": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditString": "string",
"typeDescription": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-31T19:25:00.752Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-31T19:25:00.752Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"actionTakenDate": "2024-01-31T19:25:00.752Z",
"actionTakenBy": "string",
"actionUndoneDate": "2024-01-31T19:25:00.752Z",
"actionUndoneBy": "string",
"actionEmailGroup": 0,
"onFailure": "string",
"secondaryActionTimer": 0,
"events": [
{
"dbid": 0,
"eventDate": "2024-01-31T19:25:00.752Z",
"deviceID": 0,
"sourceIP": "string",
"sourceMac": "string",
"destinationIP": "string",
"destinationMac": "string",
"alertType": "string",
"subtype": "string",
"severity": 0,
"threatID": "string",
"eventDescription": "string",
"sourceLocation": "string",
"destinationLocation": "string",
"vendor": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-31T19:25:00.752Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"activities": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"type": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditString": "string",
"typeDescription": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-31T19:25:00.752Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"continueOnFailure": true,
"stopOnFailure": true,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-31T19:25:00.752Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"filtered": 0,
"total": 0
}