Skip to main content
Skip table of contents

Unzip Files and Save to Playbook‎

POST /Command/UnzipAndSave

Extract files from zip files provided by File IDs and save to playbook

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<string>

Optional

The array of IDs of the zip files

File Passwords

array<string>

Optional

The array of passwords of the zip files

Body Sample Data

application/json
JSON
{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "File IDs": [
      "271"
    ],
    "File Passwords": [
      "password"
    ]
  }
}

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": "File ID: 271 Cannot read that as a ZipFile",
    "returnData": "Failed",
    "rawData": "",
    "contextData": [],
    "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."}
JavaScript errors detected

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

If this problem persists, please contact our support.