POST /config/domain_management/domains/{domain_id}

Updates an existing domain.

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.	{ "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.
500	1020	An error occurred while the domain was being updated.

Response Description

The updated domain object.

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
}