Get Policy Risk
Description
Get risk trend sorted by policy category and time range.
URL
/api/v1/dashboard/policy/risk
Request Method: POST
Request Headers
|
Key |
Value |
Type |
Description |
|---|---|---|---|
| companyId | <12345> | Integer | Company ID in FortiCWP, can be obtained through Get Resource Map |
|
roleId |
<12345> |
Long |
Login user identity, can be obtained through Get Resource Map |
| Authorization | Bearer <Authorization Token> | String | Authorization credential generated by FortiCWP |
| Content-Type | application/json | String | |
|
timezone |
< +0800> |
String |
Time zone of the region. |
Request Body Parameters
| Name | Priority | Type | Description |
|---|---|---|---|
| startTime | Required | Long | Starting time of filtered open alerts in Unix Epoch timestamp. To convert date and time to Unix Epoch timestamp, refer to https://www.epochconverter.com/. |
| endTime | Required | Long | Ending time of filtered open alerts in Unix Epoch timestamp. To convert date and time to Unix Epoch timestamp, refer to https://www.epochconverter.com/. |
Sample Request
|
Request URL |
POST https://www.forticwp.com/api/v1/dashboard/policy/risk |
| Request Header |
Authorization: Bearer <Authorization_Token> Content-Type: application/json timezone: -0800 roleId: 36241 companyId: 8059334 |
| Request Body |
{ "startTime":1583358665810, "endTime":1583445065810 } |
Response Variables
|
Name |
Type |
Description |
|---|---|---|
| name | String | Type of policy risk alert |
| id | String | Policy number |
| key | String | YYYY-MM-DD'T'HH:MM:SS |
| value | integer | Total number of policy risk |
Sample Response
{
"data":[
{
"name":"compliance",
"values":[
{
"id":"0",
"key":"2020-03-07T21:00:00+0000",
"value":0
},
{
"id":"1",
"key":"2020-03-07T21:30:00+0000",
"value":0
},
{
"id":"2",
"key":"2020-03-07T22:00:00+0000",
"value":0
},
{
"id":"3",
"key":"2020-03-07T22:30:00+0000",
"value":0
},
{
"id":"4",
"key":"2020-03-07T23:00:00+0000",
"value":0
},
{
"id":"5",
"key":"2020-03-07T23:30:00+0000",
"value":0
}
]
},
{
"name":"DataAnalysis",
"values":[
{
"id":"0",
"key":"2020-03-07T21:00:00+0000",
"value":0
},
{
"id":"1",
"key":"2020-03-07T21:30:00+0000",
"value":0
},
{
"id":"2",
"key":"2020-03-07T22:00:00+0000",
"value":0
},
{
"id":"3",
"key":"2020-03-07T22:30:00+0000",
"value":0
},
{
"id":"4",
"key":"2020-03-07T23:00:00+0000",
"value":0
},
{
"id":"5",
"key":"2020-03-07T23:30:00+0000",
"value":0
}
]
},
{
"name":"Configuration Assessment",
"values":[
{
"id":"0",
"key":"2020-03-07T21:00:00+0000",
"value":0
},
{
"id":"1",
"key":"2020-03-07T21:30:00+0000",
"value":0
},
{
"id":"2",
"key":"2020-03-07T22:00:00+0000",
"value":0
},
{
"id":"3",
"key":"2020-03-07T22:30:00+0000",
"value":0
},
{
"id":"4",
"key":"2020-03-07T23:00:00+0000",
"value":0
},
{
"id":"5",
"key":"2020-03-07T23:30:00+0000",
"value":0
}
]
},
{
"name":"Threat protection",
"values":[
{
"id":"0",
"key":"2020-03-07T21:00:00+0000",
"value":0
},
{
"id":"1",
"key":"2020-03-07T21:30:00+0000",
"value":0
},
{
"id":"2",
"key":"2020-03-07T22:00:00+0000",
"value":0
},
{
"id":"3",
"key":"2020-03-07T22:30:00+0000",
"value":0
},
{
"id":"4",
"key":"2020-03-07T23:00:00+0000",
"value":0
},
{
"id":"5",
"key":"2020-03-07T23:30:00+0000",
"value":0
}
]
},
{
"name":"Integration",
"values":[
{
"id":"0",
"key":"2020-03-07T21:00:00+0000",
"value":0
},
{
"id":"1",
"key":"2020-03-07T21:30:00+0000",
"value":0
},
{
"id":"2",
"key":"2020-03-07T22:00:00+0000",
"value":0
},
{
"id":"3",
"key":"2020-03-07T22:30:00+0000",
"value":0
},
{
"id":"4",
"key":"2020-03-07T23:00:00+0000",
"value":0
},
{
"id":"5",
"key":"2020-03-07T23:30:00+0000",
"value":0
}
]
},
{
"name":"Network",
"values":[
{
"id":"0",
"key":"2020-03-07T21:00:00+0000",
"value":0
},
{
"id":"1",
"key":"2020-03-07T21:30:00+0000",
"value":0
},
{
"id":"2",
"key":"2020-03-07T22:00:00+0000",
"value":0
},
{
"id":"3",
"key":"2020-03-07T22:30:00+0000",
"value":0
},
{
"id":"4",
"key":"2020-03-07T23:00:00+0000",
"value":0
},
{
"id":"5",
"key":"2020-03-07T23:30:00+0000",
"value":0
}
]
}
]
}