Get the basic information of a site

Use this API to get the basic information of a site, such as a site ID and type.

Resource Information

Method

URL

Required authentication

GET

/V1/CMDB/Sites/SiteInfo

Yes

Parameters

Name

Description

Token*required
(header)

Place the token received from the API Log in to get an authentication token.

sitePath*required
(query)

The full path of a site, such as My Network/NA/US.

Response

Parameter

Type

Description

Example

siteInfo

object

An object with the basic information of a site.

{
  "siteInfo": [
    {
      "siteId": "1da4fda8-5d04-491b-8bb0-2e9abb989a60",
      "sitePath": "My Network/NA/US",
      "isContainer": true,
      "siteType": 0
    }
  ]
}

siteId

string

The site ID.

sitePath

string

The full path of a site.

isContainer

bool

Whether a site is container site.

siteType

integer

The type of a site:

▪0: root

▪1: container site,

▪2: leaf site