Skip to main content

Web File Repository

This Integration is part of the Web File Repository Pack.#

Supported versions

Supported Cortex XSOAR versions: 6.0.0 and later.

Simple web server with a file uploading console to store small files. This is helpful to make your environment ready for testing purpose for your playbooks or automations to download files from a web server.

Configure Web File Repository on Cortex XSOAR#

  1. Navigate to Settings > Integrations > Servers & Services.

  2. Search for Web File Repository.

  3. Click Add instance to create and configure a new integration instance.

    ParameterDescriptionRequired
    Incident typeFalse
    Long running instanceFalse
    Port mapping (<port> or <host port>:<docker port>)True
    User ID for Read/WriteFalse
    PasswordFalse
    User ID for Read-OnlyFalse
    PasswordFalse
    Authentication MethodSome of the browsers such as Chrome may not support Digest-sha256.False
    Public Read AccessAuthentication is not requiured for read accessFalse
    MIME Types for file extensions"mime-type extension [extension]*" for each line, wild-card file extensions are supported.False
    Merge with Default MIME TypesSet true to merge the specified types with the default settings, false to replace themFalse
    Attachment extensionsList of extensions to set "attachment" to Content-DispositionFalse
    Storage ProtectionTrue
    The maximum repository sizeFalse
    The maximum sandbox repository sizeFalse
  4. Click Test to validate the URLs, token, and connection.

How to Access the File Management UI#

Access the File Management UI by URL and Port (HTTP)#

In a web browser, go to http://<cortex-xsoar-server-address>:<listen_port>.

Access the File Management UI by Instance Name (HTTPS)#

To access the File Management UI by instance name, make sure Instance execute external is enabled.

  1. In Cortex XSOAR, go to Settings > About > Troubleshooting.

  2. In the Server Configuration section, verify that the instance.execute.external.<instance_name> key is set to true. If this key does not exist, click + Add Server Configuration and add the instance.execute.external.<instance_name> and set the value to true. See this documentation for further information.

  3. In a web browser, go to https://<cortex-xsoar-address>/instance/execute/<instance_name>/.

    In Multi Tenant environments, go to https://<cortex-xsoar-address>/acc_<account name>/instance/execute/<instance_name>/

Commands#

You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

wfr-status#


Get the service status

Base Command#

wfr-status

Input#

Argument NameDescriptionRequired

Context Output#

PathTypeDescription
WebFileRepository.Status.StorageUsagenumberThe current storage usage in bytes
WebFileRepository.Status.SandboxUsagenumberThe current sandbox usage in bytes
WebFileRepository.Status.StorageProtectionstringThe storage protection mode
WebFileRepository.Status.IntercommunicationIPstringThe IP address of the service to which the internal client connects
WebFileRepository.Status.IntercommunicationPortnumberThe port number of the service to which the internal client connects
WebFileRepository.Status.ExternaIPunknownThe external IP address of the service
WebFileRepository.Status.ExternalPortunknownThe external port number of the service
WebFileRepository.Status.ServerIPstringThe IP address of the service
WebFileRepository.Status.ServerPortnumberThe port number of the service

wfr-cleanup#


Remove all the files from the repository

Base Command#

wfr-cleanup

Input#

Argument NameDescriptionRequired

Context Output#

There is no context output for this command.

wfr-upload-files#


Upload files to the repository

Base Command#

wfr-upload-files

Input#

Argument NameDescriptionRequired
entry_idsThe entry ID list of files.Required
extract_archiveSet to true to extract files to archive files, otherwise false. Possible values are: true, false. Default is false.Optional
upload_directoryThe directory path where to upload. Default is /.Optional

Context Output#

There is no context output for this command.

wfr-list-files#


List files in the repository

Base Command#

wfr-list-files

Input#

Argument NameDescriptionRequired
directoryThe directory path where to list files. Default is /.Optional
recursiveSet to true to list subdirectories recursively, otherwise false. Possible values are: true, false. Default is false.Optional

Context Output#

PathTypeDescription
WebFileRepository.Files.NamestringThe file name
WebFileRepository.Files.PathstringThe file path
WebFileRepository.Files.SizenumberThe file size in bytes
WebFileRepository.Files.LastModifieddateThe last modified time

wfr-remove-files#


Remove files from the repository

Base Command#

wfr-remove-files

Input#

Argument NameDescriptionRequired
pathsThe list of the file paths.Required

Context Output#

There is no context output for this command.

wfr-download-file#


Download a file from the repository

Base Command#

wfr-download-file

Input#

Argument NameDescriptionRequired
pathThe file path.Required
save_asThe name to give the file to save.Optional

Context Output#

There is no context output for this command.

wfr-archive-zip#


Download a file to which all the files are archived

Base Command#

wfr-archive-zip

Input#

Argument NameDescriptionRequired
save_asThe name to give the archive-file to save.Optional

Context Output#

There is no context output for this command.

wfr-reset#


Reset the repository data

Base Command#

wfr-reset

Input#

Argument NameDescriptionRequired

Context Output#

There is no context output for this command.