Skip to main content
Skip table of contents

List File Names In Zipped File

LAST UPDATED: AUG 08, 2024

Return a list of the names of all the files contained in the zip archive(zip, jar, apk)

Implementation

System

Command Category

System Utility

Tags

INCIDENT ARTIFACT FILE

Inputs

Parameter Name

Required/Optional

Description

Sample Data

File ID

Required

The ID of the zip file

271

File Source

Required

Source of the file

Sample Data

File Password

Required

The password of the zip file

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
[
    "file1.txt",
    "file2.csv",
    "file3.pdf"
]

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

CODE
https:/{base_url}/{api_namespace}/api/Command/ListFileNamesInZippedFile

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 ID": <File ID here>,
    "File Source": <File Source here>,
    "File Password": <File Password here>
  }
}

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 ID

integer

Required

The ID of the zip file

File Source

string

Required

Source of the file

File Password

string

Required

The password of the zip file

Sample Request

SAMPLE DATA

JSON
{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "File ID": 271,
    "File Source": "Playbook File",
    "File Password": "password"
  }
}

Response

Response Fields

Field Name

Type

Description

error

string

The error message if the API request has failed.

returnData

string

The return data from the API request.

contextData

array<string>

The context data from the API request.

Sample Response

JSON
{
    "error": "",
    "returnData": "Successful",
    "contextData": [
        "file1.txt",
        "file2.csv",
        "file3.pdf"
    ]
}
JavaScript errors detected

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

If this problem persists, please contact our support.