Check Playbook Files' Reputation‎

POST /Command/CheckPlaybookFileReputation

Gets file names, scores with artifacts files IDs, and the files must be from artifacts, or there will be an error

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.
File IDs	`array<integer>`	Optional	The file IDs array

Body Sample Data

application/json

CODE

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "File IDs": [
      1,
      2
    ]
  }
}

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	`array<JSON Object>`	The context data from the API request.

Sample Data

CODE

{
    "error": "",
    "returnData": "Succeed",
    "contextData": [
    {
        "filename": "26633_19111804181900xx---IR-TEST-IR-xxxxxxx.pdf",
        "risklevel": "Low"
    },
    {
        "filename": "93588_19112116282355xx---ExcelExport (16).xlsx",
        "risklevel": "Low"
    }
]
}

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."}