Fortinet black logo

Get available VDOMs of an organization's site

Get available VDOMs of an organization's site

Method

URL

Description

Arguments

Outputs

GET

device/vdom/site/available/?customerId={Organization ID}&siteId={Site ID}/

Get available VDOMs of an organization's site

Organization ID, Site ID

JSON array

Arguments (URL)

Parameter

Type

Description

Organization ID

int

Organization ID

Site ID

int

Site ID

Arguments (JSON payload)

None

Outputs

Parameter

Type

Description

results

JSON array

An array of ADOMs.

Example request

curl -k -X GET -H "Authorization: Token 7f89ef48dc5bca218a8ac0268653ffafa74ce6a6ed7a8a703e113b13219b18a6" "https://<ip_address>/fpc/v1/api/device/vdom/site/available/?customerId=1&siteId=1

Example response

{ "data" : { "results" : [ { "adom" : { "customer" : [ 1 ], "flags" : "no_vpn_console", "fortimanager" : { "ha" : false, "host" : "XX.XX.XX.XX", "id" : 1, "last_poll_time" : "2023-01-10T18:53:30.475002Z", "name" : "Org1 FMG", "numericVersion" : "7.0.4", "polling" : 51, "port" : 443, "sn" : "FMG-VMTMXXXXXXXX", "status" : true, "username" : "fortiportal", "version" : "v7.0.4-build0306 220608 (GA)", "xmlPort" : 8080 }, "id" : 3, "name" : "root", "oid" : 3, "version" : "7.0" }, "alias" : "", "aps" : [], "device_ha" : false, "device_ha_info" : "", "device_oid" : 185, "devid" : "FPC-FGT1", "display_name" : "root/FPC-FGT1/root", "fortianalyzer" : null, "fortigate_name" : "FPC-FGT1", "fortimanager" : { "ha" : false, "host" : "XX.XX.XX.XX", "id" : 1, "last_poll_time" : "2023-01-10T18:53:30.475002Z", "name" : "Org1 FMG", "numericVersion" : "7.0.4", "polling" : 51, "port" : 443, "sn" : "FMG-VMTMXXXXXXXX", "status" : true, "username" : "fortiportal", "version" : "v7.0.4-build0306 220608 (GA)", "xmlPort" : 8080 }, "id" : 1, "latitude" : XX, "longitude" : XX, "name" : "root", "platform" : "FortiGate-VM64-KVM", "policypackage" : { "id" : 2, "isEnable" : false, "name" : "FPC-FGT1", "status" : "unknown" }, "site" : 1, "sn" : "FGVM01TMXXXXXXXX", "status" : "modified", "switches" : [ { "alias" : "", "display_name" : "root/FPC-FGT1/root", "id" : 1, "name" : "FSW", "site" : 1, "sn" : "S108ENXXXXXXXXX", "vdom" : { "adom" : { "customer" : [ 1 ], "flags" : "no_vpn_console", "fortimanager" : { "ha" : false, "host" : "XX.XX.XX.XX", "id" : 1, "last_poll_time" : "2023-01-10T18:53:30.475002Z", "name" : "Org1 FMG", "numericVersion" : "7.0.4", "polling" : 51, "port" : 443, "sn" : "FMG-VMTMXXXXXXXX", "status" : true, "username" : "fortiportal", "version" : "v7.0.4-build0306 220608 (GA)", "xmlPort" : 8080 }, "id" : 3, "name" : "root", "oid" : 3, "version" : "7.0" }, "alias" : "", "device_ha" : false, "device_ha_info" : "", "device_oid" : 185, "devid" : "FPC-FGT1", "display_name" : "root/FPC-FGT1/root", "fortianalyzer" : null, "fortigate_name" : "FPC-FGT1", "fortimanager" : { "ha" : false, "host" : "XX.XX.XX.XX", "id" : 1, "last_poll_time" : "2023-01-10T18:53:30.475002Z", "name" : "Org1 FMG", "numericVersion" : "7.0.4", "polling" : 51, "port" : 443, "sn" : "FMG-VMTMXXXXXXXX", "status" : true, "username" : "fortiportal", "version" : "v7.0.4-build0306 220608 (GA)", "xmlPort" : 8080 }, "id" : 1, "latitude" : XX, "longitude" : XX, "name" : "root", "organization" : { "id" : 1, "name" : "Org1" }, "platform" : "FortiGate-VM64-KVM", "policypackage" : { "id" : 2, "isEnable" : false, "name" : "FPC-FGT1", "status" : "unknown" }, "site" : 1, "sn" : "FGVM01TMXXXXXXXX", "status" : "Modified", "vdom_oid" : 3, "version" : "7.0.6" } } ], "vdom_oid" : 3, "version" : "7.0.6" } ], "totalResultsCount" : 1 }, "status" : { "code" : 0, "message" : "success" } }

Get available VDOMs of an organization's site

Method

URL

Description

Arguments

Outputs

GET

device/vdom/site/available/?customerId={Organization ID}&siteId={Site ID}/

Get available VDOMs of an organization's site

Organization ID, Site ID

JSON array

Arguments (URL)

Parameter

Type

Description

Organization ID

int

Organization ID

Site ID

int

Site ID

Arguments (JSON payload)

None

Outputs

Parameter

Type

Description

results

JSON array

An array of ADOMs.

Example request

curl -k -X GET -H "Authorization: Token 7f89ef48dc5bca218a8ac0268653ffafa74ce6a6ed7a8a703e113b13219b18a6" "https://<ip_address>/fpc/v1/api/device/vdom/site/available/?customerId=1&siteId=1

Example response

{ "data" : { "results" : [ { "adom" : { "customer" : [ 1 ], "flags" : "no_vpn_console", "fortimanager" : { "ha" : false, "host" : "XX.XX.XX.XX", "id" : 1, "last_poll_time" : "2023-01-10T18:53:30.475002Z", "name" : "Org1 FMG", "numericVersion" : "7.0.4", "polling" : 51, "port" : 443, "sn" : "FMG-VMTMXXXXXXXX", "status" : true, "username" : "fortiportal", "version" : "v7.0.4-build0306 220608 (GA)", "xmlPort" : 8080 }, "id" : 3, "name" : "root", "oid" : 3, "version" : "7.0" }, "alias" : "", "aps" : [], "device_ha" : false, "device_ha_info" : "", "device_oid" : 185, "devid" : "FPC-FGT1", "display_name" : "root/FPC-FGT1/root", "fortianalyzer" : null, "fortigate_name" : "FPC-FGT1", "fortimanager" : { "ha" : false, "host" : "XX.XX.XX.XX", "id" : 1, "last_poll_time" : "2023-01-10T18:53:30.475002Z", "name" : "Org1 FMG", "numericVersion" : "7.0.4", "polling" : 51, "port" : 443, "sn" : "FMG-VMTMXXXXXXXX", "status" : true, "username" : "fortiportal", "version" : "v7.0.4-build0306 220608 (GA)", "xmlPort" : 8080 }, "id" : 1, "latitude" : XX, "longitude" : XX, "name" : "root", "platform" : "FortiGate-VM64-KVM", "policypackage" : { "id" : 2, "isEnable" : false, "name" : "FPC-FGT1", "status" : "unknown" }, "site" : 1, "sn" : "FGVM01TMXXXXXXXX", "status" : "modified", "switches" : [ { "alias" : "", "display_name" : "root/FPC-FGT1/root", "id" : 1, "name" : "FSW", "site" : 1, "sn" : "S108ENXXXXXXXXX", "vdom" : { "adom" : { "customer" : [ 1 ], "flags" : "no_vpn_console", "fortimanager" : { "ha" : false, "host" : "XX.XX.XX.XX", "id" : 1, "last_poll_time" : "2023-01-10T18:53:30.475002Z", "name" : "Org1 FMG", "numericVersion" : "7.0.4", "polling" : 51, "port" : 443, "sn" : "FMG-VMTMXXXXXXXX", "status" : true, "username" : "fortiportal", "version" : "v7.0.4-build0306 220608 (GA)", "xmlPort" : 8080 }, "id" : 3, "name" : "root", "oid" : 3, "version" : "7.0" }, "alias" : "", "device_ha" : false, "device_ha_info" : "", "device_oid" : 185, "devid" : "FPC-FGT1", "display_name" : "root/FPC-FGT1/root", "fortianalyzer" : null, "fortigate_name" : "FPC-FGT1", "fortimanager" : { "ha" : false, "host" : "XX.XX.XX.XX", "id" : 1, "last_poll_time" : "2023-01-10T18:53:30.475002Z", "name" : "Org1 FMG", "numericVersion" : "7.0.4", "polling" : 51, "port" : 443, "sn" : "FMG-VMTMXXXXXXXX", "status" : true, "username" : "fortiportal", "version" : "v7.0.4-build0306 220608 (GA)", "xmlPort" : 8080 }, "id" : 1, "latitude" : XX, "longitude" : XX, "name" : "root", "organization" : { "id" : 1, "name" : "Org1" }, "platform" : "FortiGate-VM64-KVM", "policypackage" : { "id" : 2, "isEnable" : false, "name" : "FPC-FGT1", "status" : "unknown" }, "site" : 1, "sn" : "FGVM01TMXXXXXXXX", "status" : "Modified", "vdom_oid" : 3, "version" : "7.0.6" } } ], "vdom_oid" : 3, "version" : "7.0.6" } ], "totalResultsCount" : 1 }, "status" : { "code" : 0, "message" : "success" } }