GET /config/network_hierarchy/networks

Retrieves the deployed network hierarchy.

Table 1. GET /config/network_hierarchy/networks resource details
MIME Type
application/json

Table 2. GET /config/network_hierarchy/networks request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
fields	query	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. GET /config/network_hierarchy/networks response codes
HTTP Response Code	Unique Code	Description
200		The network hierarchy was returned.
500	1020	An error occurred during the attempt to retrieve the network hierarchy.

Response Description

Network Hierarchy - A JSON string that contains network_hierarchy objects with the following fields:

id - Integer - The ID of the network object.
network_id - Integer - The ID of QRadar's network hierarchy.
group - String - The group of the network object.
name - String - The name of the network object.
cidr - String - The CIDR range of the network object.
description - String - The description of the network object.
domain_id - Integer - The domain ID of the network object.
location - Optional - JSON object - The GeoJSON location of the network object.
country_code - Optional - String - The country code of the network object.

Response Sample


[
    {
        "cidr": "String",
        "country_code": "String",
        "description": "String",
        "domain_id": 42,
        "group": "String",
        "id": 42,
        "location": {
            "coordinates": [
                42.5
            ],
            "type": "String"
        },
        "name": "String",
        "network_id": 42
    }
]