Skip to main content
Skip table of contents

Remove Escaping Chars from IP Addresses‎

POST /Command/UnescapeForIPs

Remove escape characters from IP Addresses in a list

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.

IP Addresses

array<string>

Required

The array of multiple IP address

Body Sample Data

application/json
JSON
{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "IP Addresses": [
      "192[.]168[.]1[.]242",
      "192[.]168[.]1[.]243"
    ]
  }
}

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

JSON
{
    "error": "",
    "returnData": "Succeed",
    "contextData": [
      {
          "ipEscape": "192[.]168[.]1[.]242",
          "ipAddress": "192.168.1.242"
      },
      {
          "ipEscape": "192[.]168[.]1[.]243",
          "ipAddress": "192.168.1.243"
      }
    ]
}

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."}
JavaScript errors detected

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

If this problem persists, please contact our support.