Update Event
This command is designed to perform selective updates on specific extracted fields of an event, ensuring targeted modifications without compromising the overall integrity and consistency of the event data.
Reader Note
Please note that this command is not publicly available. To request access, please contact D3 support.
Implementation | System |
Command Category | System Utility |
Tags | EVENT |
Inputs
Parameter Name | Event Id r | Update Information |
Required/Optional | Required | Required |
Description | The id of the event | Event fields to be updated. Note the investigator name is the username not firstname + lastname |
Sample Data | 225 |
CODE
|
Output
Remote Command API
The D3 command API allows you to send requests to D3 SOAR to execute this utility command via REST API.
Request
POST
https:/{base_url}/{api_namespace}/api/Command/UpdateEvent
Headers
Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.
Request Body
{
"Username": <Username here>,
"Site": <Site here>,
"CommandParams": {
"Event Id": <Event Id here>,
"Update Information": <The Update Information contains fields and value here>
}
}
Body Parameters
Parameter Name | Type | Required/Optional | Description |
Username |
| Required | The username of your D3 SOAR account. |
Site |
| Required | The D3 SOAR site to run the remote command. |
Event Id |
| Required | The id of the event |
Update Information |
| Required | Event fields to be updated. Note the investigator name is the username not firstname + lastname |
Sample Request
{
"Username": "Admin",
"Site": "Security Operations",
"CommandParams": {
"Event Id": 225,
"Update Information": {
"Event Summary": {
"Start Time (UTC)": "2023-09-01 11:11:11",
"Event Type": "Security Update",
"Risk Level": "High",
"Investigator Name": "admin",
"Description": "This is an event"
},
"Event Details": {
"Location": "Data Center 2",
"Impact": "High",
"Urgency": "High"
}
}
}
}
Response
Response Fields
Field Name | Type | Description |
error |
| The error message if the API request has failed. |
returnData |
| The return data from the API request. |
Sample Response
{
"error": "",
"returnData": {
"Status": "Successful",
"Data": {
"Event Summary": {
"Start Time (UTC)": "2023-09-01 12:22:11",
"Event Type": "1111111111",
"Risk Level": "High",
"Investigator Name": "admin",
"Description": "222222222"
},
"Event Details": {
"URL": "33",
"Transport layer protocol": "4444"
}
},
"Error Data": ""
}
}