Get Artifact From Json Array‎

POST /Command/GetArtifactFromJsonArray

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.
Type	`array<string>`	Optional	Artifact Type (Text Array) - This is the artifact type the user wants to extract (e.g., IP, URL, domain, email, hash). If the user does not enter a type, the command will extract all five kinds of artifacts by default.
Input Array	`array<JSON Object>`	Required	JSON Array - This is the actual data to be searched

Body Sample Data

application/json

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Type": [
      "ip",
      "url",
      "domain",
      "email",
      "hash"
    ],
    "Input Array": [
      {
        "field1": "example.com",
        "field2": "test@baidu.com"
      },
      {
        "field1": "www.google.com",
        "field2": {
          "email": "jaxx@example.com",
          "RiskLevel": "High"
        }
      },
      {
        "field1": "hello@d3security.com",
        "field2": "world@gmail.com",
        "IP": "55.99.44.12"
      },
      {
        "String": "D3security",
        "Hash": "bc9c7a6bbd00010d2de8812ec73c5cxx",
        "SHA256Hash": "6AF39D89988346A398604FEB5BA5BE28CE4C2D5951358AA09B964C58764E6Exx",
        "SHA1Hash": "ec53ba1cfc093c0ee96f7c39e5cc612b7f4a23xx",
        "IP": "127.0.0.1"
      },
      {
        "Company": "D3Security",
        "URL": "http://www.d3security.com",
        "DocNumber": "20190917-19022",
        "DocURL": "http://192.168.1.193/VSOC/d3_ir/pages",
        "IP": "192.168.1.242"
      }
    ]
  }
}

Response

200 OK

application/json

Response Fields

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

Sample Data

JSON

{
    "error": "",
    "returnData": "{
    "Status": "Successful",
    "Data": {
        "Domains": [
            "example.com",
            "baidu.com",
            "www.google.com",
            "tencent.com",
            "d3security.com",
            "gmail.com",
            "55.99.44.12",
            "127.0.0.1",
            "www.d3security.com",
            "192.168.1.193",
            "192.168.1.242"
        ],
        "Ips": {
            "InternalIps": [
                "192.168.1.24x",
                "127.0.0.1"
            ],
            "ExteranlIps": [
                "55.99.44.12"
            ]
        },
        "Hashes": {
            "MD5Hash": [
                "bc9c7a6bbd00010d2de8812ec73c5c7x"
            ],
            "SHA256Hash": [
                "6AF39D89988346A398604FEB5BA5BE28CE4C2D5951358AA09B964C58764E6E2x"
            ],
            "SHA1Hash": [
                "ec53ba1cfc093c0ee96f7c39e5cc612b7f4a23xx"
            ],
            "CombinedHash": [
                "bc9c7a6bbd00010d2de8812ec73c5c7x",
                "6AF39D89988346A398604FEB5BA5BE28CE4C2D5951358AA09B964C58764E6Exx",
                "ec53ba1cfc093c0ee96f7c39e5cc612b7f4a23xx"
            ]
        },
        "EmailAddresses": [
            "test@baidu.com",
            "xx@tencent.com",
            "hello@d3security.com",
            "world@gmail.com"
        ],
        "Urls": [
            "http://www.d3security.com",
            "http://192.168.1.193/VSOC/d3_ir/pages"
        ]
    }
  }
}

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