Version:

Version:

Version:

Version:


Table of Contents

Online Help

Get Virtual Machine Overview

Description

Get virtual machine overview.

URL

/api/v1/dashboard/vm

Method: Get

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

GET https://www.forticwp.com/api/v1/dashboard/vm

Request Header

Authorization: Bearer <Authorization_Token>

roleId: 36241

companyId: 8059334

Content-Type: application/json

Response Variables

Name Type Description
service String Cloud Service such as AWS, Google Cloud, etc.
critical Integer Number of virtual machines at critical severity level status.
alert Integer Number of virtual machines at alert severity level status.
warning Integer Number of virtual machines at warning severity level status.
information Integer Number of virtual machines at information severity level status.
noRisk Integer Number of virtual machines at safe severity level status.

Sample response

[

{

"service":"AWS",

"critical":12,

"alert":10,

"warning":9,

"information":8,

"noRisk":7

},

{

"service":"AZURE",

"critical":12,

"alert":10,

"warning":9,

"information":8,

"noRisk":7

}

]

 

 

 

 

Get Virtual Machine Overview

Description

Get virtual machine overview.

URL

/api/v1/dashboard/vm

Method: Get

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

GET https://www.forticwp.com/api/v1/dashboard/vm

Request Header

Authorization: Bearer <Authorization_Token>

roleId: 36241

companyId: 8059334

Content-Type: application/json

Response Variables

Name Type Description
service String Cloud Service such as AWS, Google Cloud, etc.
critical Integer Number of virtual machines at critical severity level status.
alert Integer Number of virtual machines at alert severity level status.
warning Integer Number of virtual machines at warning severity level status.
information Integer Number of virtual machines at information severity level status.
noRisk Integer Number of virtual machines at safe severity level status.

Sample response

[

{

"service":"AWS",

"critical":12,

"alert":10,

"warning":9,

"information":8,

"noRisk":7

},

{

"service":"AZURE",

"critical":12,

"alert":10,

"warning":9,

"information":8,

"noRisk":7

}

]