GET /config/domain_management/domains/{domain_id}

date_range 24-May-22

arrow_backward

arrow_forward

SUMMARY Gets an individual domain by ID

Gets an individual domain by ID You must have the System Administrator or Security Administrator permissions to call this endpoint if you are trying to retrieve the details of a domain that isn't assigned to your Security Profile. You can retrieve details of domains that are assigned to your Security Profile without having the System Administrator or Security Administrator permissions. If you do not have the System Administrator or Security Administrator permissions, then for each domain assigned to your security profile you can only view the values for the id and name fields. All other values return null.

Table 1: GET /config/domain_management/domains/{domain_id} resource details:
GET /config/domain_management/domains/{domain_id} resource details
MIME Type
application/json

Table 2: GET /config/domain_management/domains/{domain_id} request parameter details:
GET /config/domain_management/domains/{domain_id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
domain_id	path	Required	Number (Integer)	text/plain	The ID of the domain to get.
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/{domain_id} response codes:
GET /config/domain_management/domains/{domain_id} response codes
HTTP Response Code	Unique Code	Description
200		The domain has been successfully retrieved.
404	1002	No domain was found for the provided domain id.
500	1020	An error occurred while the domain was being retrieved.

Response Description

A domain object.

id - Integer - The ID of the domain.
name - String - The name of the domain.
description - String - The description given to the domain.
tenant_id - Integer - The ID of the tenant that this domain belongs to.
deleted - Boolean - Whether or not the domain has been deleted.
event_collector_ids - Array of Longs - The list of event collector IDs that are assigned to this domain.
log_source_ids - Array of Longs - The list of log source IDs that are assigned to this domain.
log_source_group_ids - Array of Longs - The list of log source group IDs that are assigned to this domain.
custom_properties - Array of Custom Property Objects - The list of custom properties that are assigned to this domain.
flow_source_ids - Array of Longs - The list of flow source IDs that are assigned to this domain.
flow_collector_ids - Array of Longs - The list of flow collector IDs that are assigned to this domain.
asset_scanner_ids - Array of Longs - The list of asset scanner IDs that are assigned to this domain.
qvm_scanner_ids - Array of Longs - The list of QVM scanner IDs that are assigned to this domain.
flow_vlans_ids - Array of Longs - The list of flow VLAN IDs that are assigned to this domain.

Response Sample

content_copy zoom_out_map
{
    "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
}

arrow_backward PREVIOUS DELETE /config/domain_management/domains/{domain_id}

NEXT arrow_forward POST /config/domain_management/domains/{domain_id}

REST API Version 17.0 References

ON THIS PAGE

GET /config/domain_management/domains/{domain_id}

Response Description

Response Sample

Stay in touch

Helped me install or use the product
Accelerated my deployment

Discuss the product with a co-worker
Make a purchase inquiry