Get Highlight List
Description
Get cloud resource highlights and type in a list.
URL
/api/v1/profile/resource/highlight/list
Request Method: POST
Request Header
|
Key |
Value |
Type |
Description |
|---|---|---|---|
| companyId | <12345> | Integer | Company ID - Company ID can be obtained through Get Resource Map |
| Authorization | Bearer <Authorization Token> | String | Authorization credential generated by FortiCWP |
| Content-Type | application/json | String |
Sample Request
|
Request URL |
POST https://www.forticwp.com/api/v1/profile/resource/highlight/list |
| Request Header |
Authorization: Bearer <Authorization_Token> companyId: <Company_ID> Content-Type: application/json |
Response Variable
|
Name |
Type |
Description |
|---|---|---|
| select | Boolean | Resource type selected or not in highlight |
| key | String | Resource type in highlight |
| data | Array | Resource highlight detail |
| limit | Integer | Maximum number of return highlight type in a page |
| skip | Integer | Indexes in a result set, used to exclude a response from the first N items of a resource collection. |
| totalCount | Integer | Total number of highlight type |
| totalPage | Integer | Total page of highlight type |
| data.option | Array | Resource highlight type list |
| data | String | Content of highlight resource type |
Sample Resposne
{
"data":[
{
"select":false,
"option":[
{
"select":false,
"key":"VPN CONNECTION",
"data":[
"VPN-vpn-03b1b68245ec89892eBg1CeAnQayLUMkot0ODAg",
"VPN-vpn-0f64623ae39bcb419ZmBNwVNkTFySD0y4I8C7bw",
"VPN-vpn-03b1b68245ec89892wjJKstiVSs-2jAgOi33A4Q",
"VPN-vpn-0f64623ae39bcb419fSmBwvL3TFe1jp2l257-Fg"
]
},
{
"select":false,
"key":"Security Group",
"data":[
"0.0.0.0/0"
]
},
{
"select":false,
"key":"Network",
"data":[
"Internet facing - anywhere",
"Internet facing",
"Internet facing - custom",
"Risk connection"
]
},
{
"select":false,
"key":"Peer Connection",
"data":[
"cloudsql-mysql-googleapis-com",
"pcx-0951894262105aa89",
"test1",
"servicenetworking-googleapis-com"
]
},
{
"select":false,
"key":"share level",
"data":[
"Internal Write",
"External Read",
"Private",
"Public Read",
"Public Write",
"External Write"
]
},
{
"select":false,
"key":"document status",
"data":[
"malware",
"sensitive"
]
}
]
}
],
"totalPage":0,
"limit":0,
"skip":0,
"totalCount":0
}