Get /policy/security-rule
Description
Returns a list of Security Rule 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-rule |
| Request Header |
Authorization: Bearer <Authorization_Token> Content-Type: application/json
|
Sample Response
{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-02T00:28:33.416Z",
"enabled": true,
"name": "string",
"description": "string",
"trigger": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-02T00:28:33.416Z",
"dbid": 0,
"name": "string",
"timeLimit": 0,
"numberOfMatches": 0,
"activities": [
{
"dbid": 0,
"triggerID": 0,
"type": "string",
"subtype": "string",
"description": "string",
"threatID": "string",
"vendor": "string",
"occurrences": 0,
"minSeverity": 0,
"maxSeverity": 0,
"useDestination": true,
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditString": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-02T00:28:33.416Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-02T00:28:33.416Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"hostProfile": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-02T00:28:33.416Z",
"dbid": 0,
"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-02-02T00:28:33.416Z",
"groupIDs": [
0
],
"catchAll": true,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
},
"filterSet": [
"string"
],
"locationIDs": [
0
],
"locationOperator": "OR",
"groupOperator": "OR",
"radiusFilterSet": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"attributeFilters": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"groupNames": [
"string"
],
"locationNames": [
"string"
]
},
"conditionState": "string",
"triggerEmailGroup": 0,
"actionEmailGroup": 0,
"actionState": "string",
"action": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-02T00:28:33.416Z",
"dbid": 0,
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-02-02T00:28:33.416Z",
"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-02-02T00:28:33.416Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-02T00:28:33.416Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-02T00:28:33.416Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}
],
"filtered": 0,
"total": 0
}