Version:

Version:

Version:

Version:


Table of Contents

Online Help

Get Resource Highlight

Description

Get a list of cloud resource types and highlights.

URL

/api/v1/profile/resource/highlight/list

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  

Sample Request

Request URL

POST https://www.forticwp.com/api/v1/profile/resource/highlight/list

Request Header

Authorization: Bearer <Authorization_Token>

roleId: 36241

companyId: 8059334

Content-Type: application/json

Response Variables

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 types 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 types
totalPage integer Total pages of highlight types
data.option Array Resource highlight type list
data String Content of highlight resource type

Sample Response

{

"data":[

{

"select":false,

"option":[

{

"select":false,

"key":"VPN CONNECTION",

"data":[

"VPN-vpn-050544e88d5154b26THG_xawNR-e23JafQN4-9A",

"VPN-vpn-050544e88d5154b26ekRFegFVTu-F_vy6jJiEEg",

"VPN-vpn-050544e88d5154b26N_rY0kKlQ3OmS9ePIzIEAA"

]

},

{

"select":false,

"key":"Security Group",

"data":[

"0.0.0.0/0"

]

},

{

"select":false,

"key":"Network",

"data":[

"Botnet",

"Internet facing - anywhere",

"Internet facing",

"Internet facing - custom",

"Risk connection"

]

},

{

"select":false,

"key":"Peer Connection",

"data":[

"cloudsql-mysql-googleapis-com",

"pcx-00d79faa5e5dce9c3",

"pcx-0999d8229b9e870fc",

"test1",

"servicenetworking-googleapis-com"

]

},

{

"select":false,

"key":"Peering Connection",

"data":[

"pcx-00d79faa5e5dce9c3",

"pcx-0999d8229b9e870fc"

]

},

{

"select":false,

"key":"share level",

"data":[

"External Read",

"Private",

"Public Write",

"Public Read",

"External Write"

]

},

{

"select":false,

"key":"document status",

"data":[

"malware",

"sensitive"

]

}

]

}

],

"totalPage":0,

"limit":0,

"skip":0,

"totalCount":0

}

 

 

 

 

Get Resource Highlight

Description

Get a list of cloud resource types and highlights.

URL

/api/v1/profile/resource/highlight/list

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  

Sample Request

Request URL

POST https://www.forticwp.com/api/v1/profile/resource/highlight/list

Request Header

Authorization: Bearer <Authorization_Token>

roleId: 36241

companyId: 8059334

Content-Type: application/json

Response Variables

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 types 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 types
totalPage integer Total pages of highlight types
data.option Array Resource highlight type list
data String Content of highlight resource type

Sample Response

{

"data":[

{

"select":false,

"option":[

{

"select":false,

"key":"VPN CONNECTION",

"data":[

"VPN-vpn-050544e88d5154b26THG_xawNR-e23JafQN4-9A",

"VPN-vpn-050544e88d5154b26ekRFegFVTu-F_vy6jJiEEg",

"VPN-vpn-050544e88d5154b26N_rY0kKlQ3OmS9ePIzIEAA"

]

},

{

"select":false,

"key":"Security Group",

"data":[

"0.0.0.0/0"

]

},

{

"select":false,

"key":"Network",

"data":[

"Botnet",

"Internet facing - anywhere",

"Internet facing",

"Internet facing - custom",

"Risk connection"

]

},

{

"select":false,

"key":"Peer Connection",

"data":[

"cloudsql-mysql-googleapis-com",

"pcx-00d79faa5e5dce9c3",

"pcx-0999d8229b9e870fc",

"test1",

"servicenetworking-googleapis-com"

]

},

{

"select":false,

"key":"Peering Connection",

"data":[

"pcx-00d79faa5e5dce9c3",

"pcx-0999d8229b9e870fc"

]

},

{

"select":false,

"key":"share level",

"data":[

"External Read",

"Private",

"Public Write",

"Public Read",

"External Write"

]

},

{

"select":false,

"key":"document status",

"data":[

"malware",

"sensitive"

]

}

]

}

],

"totalPage":0,

"limit":0,

"skip":0,

"totalCount":0

}