Get child sites of a specific site

This function returns a list of child sites of a specified site.

Resource Information

Method

URL

Required authentication

GET

/V1/CMDB/Sites/ChildSites

Yes

Parameters

Name

Description

Token*required
(header)

The token can be obtained by sending a POST request to the log in session endpoint and provide valid credentials.

sitePath*required
(query)

The full path of a site, for example, My Network/NA/US.

Response

Parameter

Type

Description

Example

Sites

array

A list of all child sites.

{
    "sites": [
        {
            "siteId": "47e5d1c1-5ddc-4e5f-b37c-21616193dd36",
            "sitePath": "My Network/C0/L4",
            "isContainer": false,
            "siteType": 2
        },
      {
            "siteId": "020cb2a2-d192-4c29-a9bd-53787d866f85",
            "sitePath": "My Network/C0",
            "isContainer": true,
            "children": [
                "47e5d1c1-5ddc-4e5f-b37c-21616193dd36",
                "16d1cd8e-eb8e-42ca-a19d-54d7a7fbd2a2",
                "c36eb043-a30f-4b58-b05f-957f845c40e3",
                "688bc6b2-3b34-42ff-96a2-c06687d2c03a",
                "6348e733-1c6b-4d76-8926-2d20622cf164",
                "3ed2ccba-9a00-48d7-9af0-a17e9aa8ccfb"
            ],
            "siteType": 1
        }
    ],
    "statusCode": 790200,
    "statusDescription": "Success."
}

 

siteId

string

The site ID.

sitePath

string

The full path of a site.

siteType

integer

The type of a site.

▪0: root site

▪1: container site

▪2: leaf site

isContainer

bool

Whether it is a container site.

children

array

List of child sites of the specified container site.

statusCode

integer

Code issued by NetBrain server indicating the execution result.

statusDescription

string

The explanation of the status code.