Version:

Version:

Version:

Version:


Table of Contents

Online Help

Get Resource Detail

Description

Get Resource List API is used to retrieve details of a specific cloud resource.

URL

/api/workload/v1/profile/resource/topology/detail

Request Method: GET

Request Headers

Key

Value

Type

Description

Authorization Bearer <Authorization Token> String Authorization credential generated by FortiCWP
Content-Type application/json String  
companyid <12345> Integer Company ID - Company ID can be obtained through Get Resource Map

roleid

<12345>

Long

Login user identity, can be obtained through Get Resource Map

rid

<12345>

Long

Resource ID of the resource obtained from Get Resource List

Sample Request

Request URL

GET https://www.forticwp.com/api/workload/v1/profile/resource/topology/detail

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

roleid: 895145

companyid: 895146

rid:1417572

Response Variables

Name Type Description
type String Type of the cloud resource
machineType String Type of machine running the cloud resource
status String Current status of the cloud resource
zone String Time zone of the cloud resource
name String Name of the cloud resource, it can be Azure Virtual Machine, Google Compute Engine, or EC2 Instance
resourceType String Type of cloud resource - e.g., Google Compute Engine Instance.
deleted Boolean Boolean expression giving the delete status of the resource, true if deleted and false if not deleted yet.
region String The region of the cloud resource.

Sample Response

{

"creationTimestamp":"2021-12-22T17:37:19.502-08:00",

"type":"instance",

"machineType":"e2-medium",

"status":"RUNNING",

"zone":"us-central1-c",

"project":"",

"tags":{

"fingerprint":"HAsHhu3QIhQ\u003d",

"items":[

"davidfirewall01"

]

},

"firewalls":[

{

"type":"firewall",

"creationTimestamp":"2021-12-22T17:38:10.357-08:00",

"sourceRanges":[

"0.0.0.0/0"

],

"allowed":[

{

 

}

],

"direction":"INGRESS",

"disabled":false,

"description":"",

"targetTags":[

"davidfirewall01"

],

"name":"davidfirewall01",

"resourceType":"VPC Firewall"

}

],

"networkInterfaces":[

{

"kind":"networkInterface",

"network":"devaccount-184100/regions/us-central1/subnetworks/default",

"subnetwork":"https://www.googleapis.com/compute/v1/projects/devaccount-184100/regions/us-central1/subnetworks/default",

"networkIP":"10.128.0.9",

"name":"nic0",

"accessConfigs":[

{

"kind":"accessConfig",

"type":"ONE_TO_ONE_NAT",

"name":"External NAT",

"natIP":"35.184.104.64",

"networkTier":"PREMIUM"

}

]

}

],

"name":"davidgcpvm01",

"resourceType":"Compute Engine Instance",

"region":"devaccount-184100",

"deleted":false

}

 

 

 

 

 

 

Get Resource Detail

Description

Get Resource List API is used to retrieve details of a specific cloud resource.

URL

/api/workload/v1/profile/resource/topology/detail

Request Method: GET

Request Headers

Key

Value

Type

Description

Authorization Bearer <Authorization Token> String Authorization credential generated by FortiCWP
Content-Type application/json String  
companyid <12345> Integer Company ID - Company ID can be obtained through Get Resource Map

roleid

<12345>

Long

Login user identity, can be obtained through Get Resource Map

rid

<12345>

Long

Resource ID of the resource obtained from Get Resource List

Sample Request

Request URL

GET https://www.forticwp.com/api/workload/v1/profile/resource/topology/detail

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

roleid: 895145

companyid: 895146

rid:1417572

Response Variables

Name Type Description
type String Type of the cloud resource
machineType String Type of machine running the cloud resource
status String Current status of the cloud resource
zone String Time zone of the cloud resource
name String Name of the cloud resource, it can be Azure Virtual Machine, Google Compute Engine, or EC2 Instance
resourceType String Type of cloud resource - e.g., Google Compute Engine Instance.
deleted Boolean Boolean expression giving the delete status of the resource, true if deleted and false if not deleted yet.
region String The region of the cloud resource.

Sample Response

{

"creationTimestamp":"2021-12-22T17:37:19.502-08:00",

"type":"instance",

"machineType":"e2-medium",

"status":"RUNNING",

"zone":"us-central1-c",

"project":"",

"tags":{

"fingerprint":"HAsHhu3QIhQ\u003d",

"items":[

"davidfirewall01"

]

},

"firewalls":[

{

"type":"firewall",

"creationTimestamp":"2021-12-22T17:38:10.357-08:00",

"sourceRanges":[

"0.0.0.0/0"

],

"allowed":[

{

 

}

],

"direction":"INGRESS",

"disabled":false,

"description":"",

"targetTags":[

"davidfirewall01"

],

"name":"davidfirewall01",

"resourceType":"VPC Firewall"

}

],

"networkInterfaces":[

{

"kind":"networkInterface",

"network":"devaccount-184100/regions/us-central1/subnetworks/default",

"subnetwork":"https://www.googleapis.com/compute/v1/projects/devaccount-184100/regions/us-central1/subnetworks/default",

"networkIP":"10.128.0.9",

"name":"nic0",

"accessConfigs":[

{

"kind":"accessConfig",

"type":"ONE_TO_ONE_NAT",

"name":"External NAT",

"natIP":"35.184.104.64",

"networkTier":"PREMIUM"

}

]

}

],

"name":"davidgcpvm01",

"resourceType":"Compute Engine Instance",

"region":"devaccount-184100",

"deleted":false

}