GET /config/domain_management/domains

Retrieves the list of all domains, active and deleted (including the default one).

Retrieves the list of all domain objects, active and deleted (including the default one).

The list is ordered by domain id. If domains have never been configured, only the default domain is returned.

Table 1. GET /config/domain_management/domains resource details
MIME Type
application/json

Table 2. GET /config/domain_management/domains request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
Range	header	Optional	String	text/plain	Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.
filter	query	Optional	String	text/plain	Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.
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/domain_management/domains response codes
HTTP Response Code	Unique Code	Description
200		The domain list has been successfully retrieved.
500	1020	An error occurred while the domain list was being retrieved.

Response Description

The list of domain objects.

Response Sample


[
    {
        "asset_scanner_ids": [
            42
        ],
        "custom_properties": [
            {
                "capture_result": "String",
                "id": 42
            }
        ],
        "deleted": true,
        "description": "String",
        "event_collector_ids": [
            42
        ],
        "flow_collector_ids": [
            42
        ],
        "flow_source_ids": [
            42
        ],
        "flow_vlan_ids": [
            42
        ],
        "id": 42,
        "log_source_group_ids": [
            42
        ],
        "log_source_ids": [
            42
        ],
        "name": "String",
        "qvm_scanner_ids": [
            42
        ],
        "tenant_id": 42
    }
]