DELETE /config/domain_management/domains/{domain_id}

Deletes a domain by domain id.

Deletes a domain by domain id. All domain mappings will be deleted as well. You must have the System Administrator or Security Administrator permissions to call this endpoint.

Table 1. DELETE /config/domain_management/domains/{domain_id} resource details
MIME Type
application/json

Table 2. DELETE /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 object to delete.
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. DELETE /config/domain_management/domains/{domain_id} response codes
HTTP Response Code	Unique Code	Description
200		The domain has been successfully deleted.
404	1002	No domain was found for the provided domain id.
422	1005	Default domain cannot be deleted.
422	1012	Domain cannot be deleted as it is assigned to one or more staged security profiles.
422	1013	Domain cannot be deleted as it is assigned to one or more deployed security profiles.
500	1020	An error occurred while the domain was being deleted.

Response Description

The deleted domain object with its parameter deleted set to true.

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.
disconnected_log_collector_ids - Array of Longs - The new list of disconnected log 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 Properties - 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


{
    "asset_scanner_ids": [
        42
    ],
    "custom_properties": [
        {
            "capture_result": "String",
            "id": 42
        }
    ],
    "deleted": true,
    "description": "String",
    "disconnected_log_collector_ids": [
        42
    ],
    "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
}