Fortinet black logo

Get a site

Get a site

Method

URL

Description

Arguments

Outputs

Get

device/site/{SIte ID}/

Get a site

SIte ID

JSON array

Arguments (URL)

Parameter

Type

Description

Site ID

int

Site ID

Arguments (JSON payload)

None.

Outputs (site)

Parameter

Type

Description

site

JSON array

The site record

Example request

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

Example response

{
   "data" : {
      "aps" : [],
      "contactName" : "",
      "customer" : 1,
      "email" : "",
      "extenders" : [],
      "id" : 1,
      "name" : "site1",
      "phone" : "",
      "sandbox" : false,
      "switches" : [],
      "user" : [],
      "vdoms" : [
         {
            "adom" : {
               "customer" : [
                  1
               ],
               "flags" : "no_vpn_console",
               "fortimanager" : {
                  "certificate_validation" : false,
                  "ha" : false,
                  "ha_vrrp" : false,
                  "ha_vrrp_primary_ip" : null,
                  "host" : "XXX.XXX.XXX.XXX",
                  "id" : 3,
                  "last_poll_time" : "2023-12-13T23:04:56.594250Z",
                  "name" : "FMG1",
                  "numericVersion" : "7.4.1",
                  "polling" : 52,
                  "port" : 443,
                  "selected_certificate" : null,
                  "sn" : "FMG-VMTMXXXXXXX",
                  "status" : true,
                  "username" : "fortiportal",
                  "version" : "v7.4.1-build2308 230831 (GA)",
                  "xmlPort" : 8080
               },
               "id" : 7,
               "name" : "72",
               "oid" : 169,
               "version" : "7.2"
            },
            "alias" : "",
            "aps" : [],
            "device_ha" : false,
            "device_ha_info" : "",
            "device_oid" : 165,
            "devid" : "FPC-FGT1",
            "display_name" : "72/FPC-FGT1/root",
            "extenders" : [],
            "fortianalyzer" : null,
            "fortigate_name" : "FPC-FGT1",
            "fortimanager" : {
               "certificate_validation" : false,
               "ha" : false,
               "ha_vrrp" : false,
               "ha_vrrp_primary_ip" : null,
               "host" : "192.168.1.55",
               "id" : 3,
               "last_poll_time" : "2023-12-13T23:04:56.594250Z",
               "name" : "FMG1",
               "numericVersion" : "7.4.1",
               "polling" : 52,
               "port" : 443,
               "selected_certificate" : null,
               "sn" : "FMG-VMTMXXXXXXX",
               "status" : true,
               "username" : "fortiportal",
               "version" : "v7.4.1-build2308 230831 (GA)",
               "xmlPort" : 8080
            },
            "id" : 1,
            "latitude" : XXX,
            "longitude" : XXX,
            "name" : "root",
            "platform" : "FortiGate-VM64-KVM",
            "policypackage" : null,
            "site" : 1,
            "sn" : "FGVMULTMXXXXXXXX",
            "status" : "modified",
            "switches" : [],
            "vdom_oid" : 3,
            "version" : "7.2.6"
         }
      ]
   },
   "status" : {
      "code" : 0,
      "message" : "success"
   }
}

Get a site

Method

URL

Description

Arguments

Outputs

Get

device/site/{SIte ID}/

Get a site

SIte ID

JSON array

Arguments (URL)

Parameter

Type

Description

Site ID

int

Site ID

Arguments (JSON payload)

None.

Outputs (site)

Parameter

Type

Description

site

JSON array

The site record

Example request

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

Example response

{
   "data" : {
      "aps" : [],
      "contactName" : "",
      "customer" : 1,
      "email" : "",
      "extenders" : [],
      "id" : 1,
      "name" : "site1",
      "phone" : "",
      "sandbox" : false,
      "switches" : [],
      "user" : [],
      "vdoms" : [
         {
            "adom" : {
               "customer" : [
                  1
               ],
               "flags" : "no_vpn_console",
               "fortimanager" : {
                  "certificate_validation" : false,
                  "ha" : false,
                  "ha_vrrp" : false,
                  "ha_vrrp_primary_ip" : null,
                  "host" : "XXX.XXX.XXX.XXX",
                  "id" : 3,
                  "last_poll_time" : "2023-12-13T23:04:56.594250Z",
                  "name" : "FMG1",
                  "numericVersion" : "7.4.1",
                  "polling" : 52,
                  "port" : 443,
                  "selected_certificate" : null,
                  "sn" : "FMG-VMTMXXXXXXX",
                  "status" : true,
                  "username" : "fortiportal",
                  "version" : "v7.4.1-build2308 230831 (GA)",
                  "xmlPort" : 8080
               },
               "id" : 7,
               "name" : "72",
               "oid" : 169,
               "version" : "7.2"
            },
            "alias" : "",
            "aps" : [],
            "device_ha" : false,
            "device_ha_info" : "",
            "device_oid" : 165,
            "devid" : "FPC-FGT1",
            "display_name" : "72/FPC-FGT1/root",
            "extenders" : [],
            "fortianalyzer" : null,
            "fortigate_name" : "FPC-FGT1",
            "fortimanager" : {
               "certificate_validation" : false,
               "ha" : false,
               "ha_vrrp" : false,
               "ha_vrrp_primary_ip" : null,
               "host" : "192.168.1.55",
               "id" : 3,
               "last_poll_time" : "2023-12-13T23:04:56.594250Z",
               "name" : "FMG1",
               "numericVersion" : "7.4.1",
               "polling" : 52,
               "port" : 443,
               "selected_certificate" : null,
               "sn" : "FMG-VMTMXXXXXXX",
               "status" : true,
               "username" : "fortiportal",
               "version" : "v7.4.1-build2308 230831 (GA)",
               "xmlPort" : 8080
            },
            "id" : 1,
            "latitude" : XXX,
            "longitude" : XXX,
            "name" : "root",
            "platform" : "FortiGate-VM64-KVM",
            "policypackage" : null,
            "site" : 1,
            "sn" : "FGVMULTMXXXXXXXX",
            "status" : "modified",
            "switches" : [],
            "vdom_oid" : 3,
            "version" : "7.2.6"
         }
      ]
   },
   "status" : {
      "code" : 0,
      "message" : "success"
   }
}