Set Artifact State‎

POST /Command/SetArtifactState

Sets the state of an artifact

Request

Authentication: API keys or JSON web tokens (JWT)

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>`	Optional	The name of the artifacts
Artifact Type	`string`	Optional	The type of the artifact
State	`string`	Optional	The state for the input artifacts
Description	`string`	Optional	The description for the input artifacts

Body Sample Data

application/json

JSON

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

200 OK

application/json

Response Fields

Field Name	Type	Description
error	`string`	The error message if the command execution failed.
returnData	`string`	The return data from the API request.
contextData	`JSON Object`	The context data from the API request.

Sample Data

JSON

{
    "error": "",
    "returnData": "Succeed",
    "rawData": "",
    "contextData": {
        "artifacts": [],
        "state": "Block",
        "description": "Related to crypto currency mining, need to be blocked"
    },
    "outputData": ""
}

400 BadRequest

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The body of the request must be a valid JSON object"}

401 Unauthorized

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Invalid authentication key."}

429 TooManyRequests

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The request exceeds rate limits or is otherwise blocked by rate limiting policies."}

500 InternalServerError

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Unexpected Error."}