Set Artifact State
LAST UPDATED: AUG 23, 2024
Sets the state and description of one or more artifacts.
Implementation | System |
Command Category | Cyber Utility |
Tags | ARTIFACT |
Inputs
Parameter Name | Required/Optional | Description | Sample Data |
---|---|---|---|
Artifact Names | Required | The names of the artifacts. | [ "216.251.148.1", "xmr.pool.minergate.com" ] |
Artifact Type | Optional | The type of the artifact(s). | External Endpoint |
State | Optional | A user-defined state for the artifacts. | Block |
Description | Optional | A description for the artifacts. | Related to crypto currency mining, need to be blocked |
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/SetArtifactState
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": {
"Artifact Names": <Artifact Names here>,
"Artifact Type": <Artifact Type here>,
"State": <State here>,
"Description": <Description 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. |
Artifact Names |
| Required | The names of the artifacts. |
Artifact Type |
| Optional | The type of the artifact(s). |
State |
| Optional | A user-defined state for the artifacts. |
Description |
| Optional | A description for the artifacts. |
Sample Request
SAMPLE DATA
{
"Username": "Admin",
"Site": "Security Operations",
"CommandParams": {
"Artifact Names": [
"216.251.148.1",
"xmr.pool.minergate.com"
],
"Artifact Type": "External Endpoint",
"State": "Block",
"Description": "Related to crypto currency mining, need to be blocked"
}
}
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. |
contextData |
| The context data from the API request. |
Sample Response
{
"error": "",
"returnData": "Succeed",
"contextData": {
"artifacts": [
"216.251.148.1",
"xmr.pool.minergate.com"
],
"state": "Block",
"description": "Related to cryptocurrency mining, need to be blocked"
}
}