Skip to main content
Skip table of contents

Set Artifact Is Key Asset Field

LAST UPDATED: FEB 27, 2024

Set whether an artifact is a key asset or not. Only works for artifact that are of type internal endpoint.

Implementation

System

Command Category

Cyber Utility

Tags

ARTIFACT

Inputs

Parameter Name

Required/Optional

Description

Sample Data

Artifact Name

Optional

The name of the artifact

test

Is Key Asset

Optional

Whether the artifact is a key asset or not

True

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

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

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 Name": <Artifact Name here>,
    "Is Key Asset": <Is Key Asset 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 Name

Text

Optional

The name of the artifact

Is Key Asset

Boolean

Optional

Whether the artifact is a key asset or not

Sample Request

SAMPLE DATA

JSON
{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Artifact Name": "test",
    "Is Key Asset": "True"
  }
}

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.

Sample Response

JSON
{
    "error": "",
    "returnData": "Successful"
}
JavaScript errors detected

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

If this problem persists, please contact our support.