Fortinet black logo

Get VDOMs of an organization site

Get VDOMs of an organization site

Method

URL

Description

Arguments

Outputs

GET

device/vdom/site/{Site ID}/

Get all VDOMs of an organization site

Site ID

JSON array

Arguments (URL)

Parameter

Type

Description

Site ID

int

Site ID

Arguments (JSON payload)

None

Outputs

Parameter

Type

Description

results

JSON array

VDOM information for the specified organization site

Example request

curl -k -X GET -H "Authorization: Token 7f89ef48dc5bca218a8ac0268653ffafa74ce6a6ed7a8a703e113b13219b18a6" https://<ip_address>/fpc/v1/api/device/vdom/site/3/

Example response

{

"data" : {

"results" : [

{

"adom" : {

"customer" : [

1

],

"flags" : "no_vpn_console",

"fortimanager" : {

"ha" : false,

"host" : "XXX.XXX.XXX.XXX",

"id" : 1,

"last_poll_time" : "2022-09-12T17:46:59.828879Z",

"name" : "FMG1",

"numericVersion" : "7.0.4",

"polling" : 51,

"port" : 443,

"sn" : "FMG-VMTMXXXXXXX",

"status" : true,

"username" : "fortiportal",

"version" : "v7.0.4-build0306 220608 (GA)",

"xmlPort" : 8080

},

"id" : 2,

"name" : "root",

"oid" : 3,

"version" : "7.0"

},

"alias" : "",

"device_ha" : false,

"device_ha_info" : "",

"device_oid" : 160,

"devid" : "FPC-FGT1",

"fortianalyzer" : null,

"fortigate_name" : "FPC-FGT1",

"fortimanager" : {

"ha" : false,

"host" : "XXX.XXX.XXX.XXX",

"id" : 1,

"last_poll_time" : "2022-09-12T17:46:59.828879Z",

"name" : "FMG1",

"numericVersion" : "7.0.4",

"polling" : 51,

"port" : 443,

"sn" : "FMG-VMTMXXXXXXX",

"status" : true,

"username" : "fortiportal",

"version" : "v7.0.4-build0306 220608 (GA)",

"xmlPort" : 8080

},

"id" : 1,

"latitude" : XX.XXXX,

"longitude" : XX.XXX,

"name" : "root",

"organization" : {

"id" : 1,

"name" : "Org1"

},

"platform" : "FortiGate-VM64-KVM",

"policypackage" : null,

"site" : 3,

"sn" : "FGVMXXXXXXXXXX",

"status" : "Synchronized",

"vdom_oid" : 3,

"version" : "7.0.6"

}

],

"totalResultsCount" : 1

},

"status" : {

"code" : 0,

"message" : "success"

}

}

Get VDOMs of an organization site

Method

URL

Description

Arguments

Outputs

GET

device/vdom/site/{Site ID}/

Get all VDOMs of an organization site

Site ID

JSON array

Arguments (URL)

Parameter

Type

Description

Site ID

int

Site ID

Arguments (JSON payload)

None

Outputs

Parameter

Type

Description

results

JSON array

VDOM information for the specified organization site

Example request

curl -k -X GET -H "Authorization: Token 7f89ef48dc5bca218a8ac0268653ffafa74ce6a6ed7a8a703e113b13219b18a6" https://<ip_address>/fpc/v1/api/device/vdom/site/3/

Example response

{

"data" : {

"results" : [

{

"adom" : {

"customer" : [

1

],

"flags" : "no_vpn_console",

"fortimanager" : {

"ha" : false,

"host" : "XXX.XXX.XXX.XXX",

"id" : 1,

"last_poll_time" : "2022-09-12T17:46:59.828879Z",

"name" : "FMG1",

"numericVersion" : "7.0.4",

"polling" : 51,

"port" : 443,

"sn" : "FMG-VMTMXXXXXXX",

"status" : true,

"username" : "fortiportal",

"version" : "v7.0.4-build0306 220608 (GA)",

"xmlPort" : 8080

},

"id" : 2,

"name" : "root",

"oid" : 3,

"version" : "7.0"

},

"alias" : "",

"device_ha" : false,

"device_ha_info" : "",

"device_oid" : 160,

"devid" : "FPC-FGT1",

"fortianalyzer" : null,

"fortigate_name" : "FPC-FGT1",

"fortimanager" : {

"ha" : false,

"host" : "XXX.XXX.XXX.XXX",

"id" : 1,

"last_poll_time" : "2022-09-12T17:46:59.828879Z",

"name" : "FMG1",

"numericVersion" : "7.0.4",

"polling" : 51,

"port" : 443,

"sn" : "FMG-VMTMXXXXXXX",

"status" : true,

"username" : "fortiportal",

"version" : "v7.0.4-build0306 220608 (GA)",

"xmlPort" : 8080

},

"id" : 1,

"latitude" : XX.XXXX,

"longitude" : XX.XXX,

"name" : "root",

"organization" : {

"id" : 1,

"name" : "Org1"

},

"platform" : "FortiGate-VM64-KVM",

"policypackage" : null,

"site" : 3,

"sn" : "FGVMXXXXXXXXXX",

"status" : "Synchronized",

"vdom_oid" : 3,

"version" : "7.0.6"

}

],

"totalResultsCount" : 1

},

"status" : {

"code" : 0,

"message" : "success"

}

}