POST /config/domain_management/domains/{domain_id}

Updates an existing domain.

Updates an existing domain. You must have the System Administrator or Security Administrator permissions to call this endpoint.

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

Table 2. POST /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 update.
fields	header	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. POST /config/domain_management/domains/{domain_id} request body details
Parameter	Data Type	MIME Type	Description	Sample
domain	Object	application/json	A domain JSON object. name - String - The new name of the domain. description - String - The new description of the domain. tenant_id - Integer - The new tenant ID of the domain. event_collector_ids - Array of Longs - The new list of event collector IDs for the domain. log_source_ids - Array of Longs - The new list of log source IDs for the domain. log_source_group_ids - Array of Longs - The new list of log source group ids for the domain. custom_properties - Array of Custom Properties - The new list of custom properties for the domain. flow_source_ids - Array of Longs - The new list of flow source IDs for the domain. flow_collector_ids - Array of Longs - The new list of flow source collector IDs for the domain. asset_scanner_ids - Array of Longs - The new list of asset scanner IDs for the domain. qvm_scanner_ids - Array of Longs - The new list of QVM scanner IDs for the domain. flow_vlans_ids - Array of Longs - The new list of flow VLAN IDs for the domain.	{ "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], "log_source_group_ids": [42], "log_source_ids": [42], "name": "String", "qvm_scanner_ids": [42], "tenant_id": 42 }

Table 4. POST /config/domain_management/domains/{domain_id} response codes
HTTP Response Code	Unique Code	Description
200		The domain has been successfully updated.
404	1002	No domain was found for the provided domain id.
409	1004	A domain object parameter already exists.
422	1005	A domain object parameter is invalid.
422	1010	The tenant that this domain belongs to is different than the tenant of some deployed actors that have a security profile that this domain is assigned to.
422	1011	The tenant that this domain belongs to is different than the tenant of some staged actors that have a security profile that this domain is assigned to.
500	1020	An error occurred while the domain was being updated.

Response Description

The updated 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 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",
    "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
}