Skip to main content
Skip table of contents

Set Artifact Risk Level

LAST UPDATED: FEB 27, 2024

Set the Risk Level of an artifact.

Implementation

System

Command Category

Cyber Utility

Tags

ARTIFACT

Inputs

Parameter Name

Required/Optional

Description

Sample Data

Artifact Type

Required

The artifact type of the input artifact

External Endpoint

Artifact Name

Optional

The name of the artifact

sample.vbs

Risk Level

Optional

The risk level of the input artifact

Medium

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
Successful
Context Data

The response data from the utility command.

SAMPLE DATA

JSON
{
    "artifacts": [
        {
            "name": "sample.vbs",
            "type": "External Endpoint",
            "risklevel": "Medium"
        }
    ]
}

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/SetArtifactRiskLevel

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 Type": <Artifact Type here>,
    "Artifact Name": <Artifact Name here>,
    "Risk Level": <Risk Level 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 Type

Number

Required

The artifact type of the input artifact

Artifact Name

Text

Optional

The name of the artifact

Risk Level

Number

Optional

The risk level of the input artifact

Sample Request

SAMPLE DATA

JSON
{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Artifact Type": "External Endpoint",
    "Artifact Name": "sample.vbs",
    "Risk Level": "Medium"
  }
}

Response

Response Fields

Field Name

Type

Description

error

Text

The error message if the API request has failed.

returnData

Text

The return data from the API request.

contextData

JSON Object

The context data from the API request.

Sample Response

JSON
{
    "error": "",
    "returnData": "Successful",
    "contextData": {
        "artifacts": [
            {
                "name": "sample.vbs",
                "type": "External Endpoint",
                "risklevel": "Medium"
            }
        ]
    }
}
JavaScript errors detected

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

If this problem persists, please contact our support.