Skip to main content
Skip table of contents

Set Artifact State

LAST UPDATED: SEPT 11, 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.

CODE
[
  "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.

demoState

Description

Optional

A description for the artifacts.

demoDescription

READER NOTE

The Artifact Type parameter is required when modifying the state or description of a custom artifact.

Output

Return Data

The returned result of this command. If some required parameters are not defined, this returned data could be empty. The returned result can be passed down directly to a subsequent command in playbooks.

SAMPLE DATA

JSON
Succeed
Context Data

The response data from the utility command.

SAMPLE DATA

JSON
{
    "artifacts": [
        "216.251.148.1",
        "xmr.pool.minergate.com"
    ],
    "state": "Block",
    "description": "demoDescription"
}

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

CODE
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

JSON
{
  "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

string

Required

The username of your D3 SOAR account.

Site

string

Required

The D3 SOAR site to run the remote command.

Artifact Names

array<string>

Required

The names of the artifacts.

Artifact Type

integer

Optional

The type of the artifact(s).

State

string

Optional

A user-defined state for the artifacts.

Description

string

Optional

A description for the artifacts.

Sample Request

SAMPLE DATA

JSON
{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Artifact Names": [
      "216.251.148.1",
      "xmr.pool.minergate.com"
    ],
    "Artifact Type": "External Endpoint",
    "State": "Block",
    "Description": "demoDescription"
  }
}

Response

Response Fields

Field Name

Type

Description

error

string

The error message if the API request has failed.

returnData

string

The return data from the API request.

contextData

JSON Object

The context data from the API request.

Sample Response

JSON
{
  "error": "",
  "returnData": "Succeed",
  "contextData": {
    "artifacts": [
      "216.251.148.1",
      "xmr.pool.minergate.com"
    ],
    "state": "Block",
    "description": "demoDescription"
  }
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.