Unzip Files and Save to Playbook

Last updated: feb 27, 2024

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

Implementation	System
Command Category	System Utility
Tags	Incident Artifact File

Inputs

Parameter Name	Required/Optional	Description	Sample Data
File IDs	Optional	The array of IDs of the zip files	`[ "271" ]`
File Passwords	Optional	The array of passwords of the zip files	`[ "password" ]`

Output

Return Data

The returned result of this command. If some required parameters are not defined, this returned data could be empty. The returned result can be passed down directly to a subsequent command in playbooks.

Sample Data

JSON

Successful

Context Data

The response data from the utility command.

Sample Data

JSON

[
    {
        "ZipFileID": 271,
        "FileID": 272,
        "FileName": "IR-20200119-276920200119104501.pdf",
        "MD5": "a166ff37ca915314ec0d4ecbfda4c0fc",
        "SHA1": "b1038aeda87dd7f4494e42006f3da99469d7973c",
        "SHA256": "fa0d1f2998a2cd6a5e48e508f2e05b13ad2053ee5f3e2d56cc8e7924df5b0b74"
    }
]

Remote Command API

The D3 command API allows you to send requests to D3 SOAR to execute this utility command via REST API.

Request

POST

https:/{base_url}/{api_namespace}/api/Command/UnzipAndSave

Headers

Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.

Request Body

JSON

{
  "Username": <Username here>,
  "Site": <Site here>,
  "CommandParams": {
    "File IDs": <The array of IDs of the zip files>,
    "File Passwords": <The array of passwords of the zip files>
  }
}

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	`Text Array`	Optional	The array of IDs of the zip files
File Passwords	`Text Array`	Optional	The array of passwords of the zip files

Sample Request

Sample Data

JSON

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

Response

Response Fields

Field Name	Type	Description
error	`Text`	The error message if the API request has failed.
returnData	`Text`	The return data from the API request.
contextData	`JSON Array`	The context data from the API request.

Sample Response

JSON

{
    "error": "",
    "returnData": "Successful",
    "contextData": [
    {
        "ZipFileID": 271,
        "FileID": 272,
        "FileName": "IR-20200119-276920200119104501.pdf",
        "MD5": "a166ff37ca915314ec0d4ecbfda4c0fc",
        "SHA1": "b1038aeda87dd7f4494e42006f3da99469d7973c",
        "SHA256": "fa0d1f2998a2cd6a5e48e508f2e05b13ad2053ee5f3e2d56cc8e7924df5b0b74"
    }
]
}