Version:

Version:

Version:

Version:


Table of Contents

Online Help

Get Status List

Description

Get list of all cloud account basic information and status.

URL

/api/v1/service/status/list

Method: GET

Request Headers

Key

Value

Type

Description

companyId <12345> String Company ID in FotiCWP, 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/service/status/list

Request Header

Authorization: Bearer <Authorization_Token>

companyId: 2

roleId: 36241

Content-Type: application/json

Response Variables

Name

Type

Description

companyId Integer Company id
BuId integer Business id, one service ID per one Business ID
service Application Cloud service such as AWS, Google Cloud, etc.
serviceId String Service ID to distinguish different account of the cloud service in FortiCWP
name String Nme of cloud service
role String Role of service account which shows how the cloud service is added to FortiCWP
appStatus String Monitoring status of the cloud service
vmNum integer Virtual machine instances ID number in the cloud service
workloadUsage integer Consumed workload guardian license seat(s)
storageUsage Long Storage space used by the cloud service
licenseStatus String license status of cloud service

Sample Response

[

{

"service":"GoogleCloud",

"BuId":31298,

"companyId":2,

"name":"aws",

"role":"Independent Account",

"serviceId":"@autotest.staging.forticasb.com",

"appStatus":"DELETE_PENDING",

"vmNum":10,

"workloadUsage":10,

"storageUsage":2074096,

"licenseStatus":"LICENSE",

"lastUpdate":1583782826810

},

{

"service":"Azure",

"BuId":21587,

"companyId":2,

"name":"binxufortinet@binxufortinet.onmicrosoft.com",

"role":"Independent Account",

"serviceId":"15ee8224-790c-48c6-b4c7-477e8616f71d",

"appStatus":"RUNNING",

"vmNum":4,

"workloadUsage":4,

"storageUsage":2808290,

"licenseStatus":"LICENSE"

},

{

"service":"AWS",

"BuId":3253,

"companyId":2,

"name":"677383417454",

"serviceId":"677383417454",

"appStatus":"INIT",

"vmNum":0,

"workloadUsage":0,

"storageUsage":0,

"licenseStatus":"UNLICENSE"

}

]

 

 

 

 

Get Status List

Description

Get list of all cloud account basic information and status.

URL

/api/v1/service/status/list

Method: GET

Request Headers

Key

Value

Type

Description

companyId <12345> String Company ID in FotiCWP, 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/service/status/list

Request Header

Authorization: Bearer <Authorization_Token>

companyId: 2

roleId: 36241

Content-Type: application/json

Response Variables

Name

Type

Description

companyId Integer Company id
BuId integer Business id, one service ID per one Business ID
service Application Cloud service such as AWS, Google Cloud, etc.
serviceId String Service ID to distinguish different account of the cloud service in FortiCWP
name String Nme of cloud service
role String Role of service account which shows how the cloud service is added to FortiCWP
appStatus String Monitoring status of the cloud service
vmNum integer Virtual machine instances ID number in the cloud service
workloadUsage integer Consumed workload guardian license seat(s)
storageUsage Long Storage space used by the cloud service
licenseStatus String license status of cloud service

Sample Response

[

{

"service":"GoogleCloud",

"BuId":31298,

"companyId":2,

"name":"aws",

"role":"Independent Account",

"serviceId":"@autotest.staging.forticasb.com",

"appStatus":"DELETE_PENDING",

"vmNum":10,

"workloadUsage":10,

"storageUsage":2074096,

"licenseStatus":"LICENSE",

"lastUpdate":1583782826810

},

{

"service":"Azure",

"BuId":21587,

"companyId":2,

"name":"binxufortinet@binxufortinet.onmicrosoft.com",

"role":"Independent Account",

"serviceId":"15ee8224-790c-48c6-b4c7-477e8616f71d",

"appStatus":"RUNNING",

"vmNum":4,

"workloadUsage":4,

"storageUsage":2808290,

"licenseStatus":"LICENSE"

},

{

"service":"AWS",

"BuId":3253,

"companyId":2,

"name":"677383417454",

"serviceId":"677383417454",

"appStatus":"INIT",

"vmNum":0,

"workloadUsage":0,

"storageUsage":0,

"licenseStatus":"UNLICENSE"

}

]