LiquidFiles

https://docs.liquidfiles.com/
Admin
LiquidFiles is a secure, self-hosted virtual appliance for large file transfer and secure file...
Tokens:408,838
Snippets:2,957
Trust Score:8.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example Request in XML

Source: https://docs.liquidfiles.com/deprecated/api_xml/filelink_api.html

An example of the XML structure required for a FileLink creation request.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<link>
  <attachment>12345</attachment>  
  <expires_at>2014-01-01</expires_at>  
  <download_receipt>true</download_receipt>  
  <require_authentication>true</require_authentication>
</link>
```

--------------------------------

### Start iperf3 Server

Source: https://docs.liquidfiles.com/troubleshoot/network_performance.html

Commands to stop the firewall and start the iperf3 server process.

```bash
systemctl stop firewalld  
iperf3 -s
```

--------------------------------

### Install iperf3

Source: https://docs.liquidfiles.com/troubleshoot/network_performance.html

Command to install the iperf3 network testing tool on Debian-based systems.

```bash
apt install iperf3
```

--------------------------------

### Wire transfer description example

Source: https://docs.liquidfiles.com/license/payment_options.html

Shows the correct and incorrect wire transfer description formats. The correct format begins with the quote or invoice ID, while the incorrect format starts with a longer description that gets truncated in the bank's system.

```text
Description: #150331011                                           <---- correct
Descrption: Payment for LiquidFiles license, quote #150331011    <---- incorrect
          |--------------------|                                <---- this is roughly what we see
                                                                      of your description
```

--------------------------------

### Create and Configure VM

Source: https://docs.liquidfiles.com/install/proxmox.html

Create a new VM, attach the ISO, and set the boot order using the qm command-line tool.

```bash
# Step 1: Create the VM (ID 123, Linux settings, with 40GB disk)
qm create 109 --name liquidfiles --memory 2048 --sockets 1 --cores 2 \
  --net0 virtio,bridge=vmbr0 --ostype l26 --scsi0 local-lvm:40

# Step 2: Attach the ISO as a bootable CD-ROM
qm set 109 --ide1 local:iso/LiquidFiles-v4.x.x-x86_64.iso,media=cdrom

# Step 3: Set boot order (disk first — falls through to CD-ROM on first boot)
qm set 109 --boot order='scsi0;ide1'
```

--------------------------------

### clientConfig.json example for preconfiguring server URL

Source: https://docs.liquidfiles.com/clients/mac.html

Create this file in /Users/_username_/Library/Application Support/com.liquidfiles.mac.Liquidfiles/ to preconfigure the server URL. The serverPath value should be your LiquidFiles domain.

```json
{
    "serverPath": "yourliquidfiles.domain.com"
}    
```

--------------------------------

### GET request with curl

Source: https://docs.liquidfiles.com/api

Example of a GET request where no data is sent, so only the Accept header is required.

```bash
curl -X GET -H "Authorization: Bearer gXvoqaFzd1jYQ9f13sPO06" \
     -H "Accept: application/json" \
     https://liquidfiles.example.com/message/inbox
```

--------------------------------

### GET Shares Log Response

Source: https://docs.liquidfiles.com/api/v4.3/shares/logs.html

Example JSON response containing a list of log entries for the requested share.

```json
{"logs":
  [
    {
      "id":"20240219035239187603",
      "action":"created",
      "log_type":"folder",
      "item":"/Project Data",
      "item2":null,
      "user_id":"user-company-com",
      "share_id":"project-alpha",
      "folder_id":"project-data",
      "file_id":null,
      "created_at":"2024-02-19T03:52:39.187Z"
    },
    {
      "id":"20240219153857657520",
      "action":"uploaded",
      "log_type":"file",
      "item":"/Project Data/Project Info.doc",
      "item2":null,
      "user_id":"user-company-com",
      "share_id":"project-alpha",
      "folder_id":"project-data",
      "file_id":"project-info-doc",
      "created_at":"2024-02-19T04:38:57.657Z"
    }
  ]
}
```

--------------------------------

### Example Request and Response using curl

Source: https://docs.liquidfiles.com/deprecated/api_xml/attachment_upload.html

Demonstrates how to query available chunks using curl and shows the expected XML response format.

```bash
#!/bin/sh

# Some nice variables
api_key="Y9fdTmZdv0THButt5ZONIY"
server="https://liquidfiles.company.com"

curl -X GET --user "$api_key:x" -H 'Content-Type: text/xml' $server/attachments/available_chunks?name=bigfile.zip

<?xml version="1.0" encoding="UTF-8" ?>
<chunks>
  <chunk>
    <id>0</id>
    <size>104857600</size>
  </chunk>
  <chunk>
    <id>1</id>
    <size>104857600</size>
  </chunk>
</chunks>
```

--------------------------------

### GET Shares Log Request

Source: https://docs.liquidfiles.com/api/v4.3/shares/logs.html

Example of a cURL request to retrieve logs for a specific share after a given date.

```bash
curl -X GET -H "Authorization: Bearer nkpIxMK9ucUUE7FvfNpdAf" -H "Accept: application/json" \
     https://test.host/shares/project-alpha/logs?after=2024-02-19
```

--------------------------------

### Upload Certificates for Multi-Domain Installations

Source: https://docs.liquidfiles.com/api/v4.3/system/certificate.html

Demonstrates uploading certificates for different domains by making separate API calls to each domain's hostname.

```bash
# Upload certificate for files.company.com
curl -X POST -H "Authorization: Bearer $SYSADMIN_API_KEY:x" \
     -H "Accept: application/json" \
     --data-urlencode "certificate_pem=$(cat files-cert.pem)" \
     --data-urlencode "certificate_key=$(cat files-key.pem)" \
     https://files.company.com/system/certificate

# Upload certificate for secure.company.com
curl -X POST -H "Authorization: Bearer $SYSADMIN_API_KEY:x" \
     -H "Accept: application/json" \
     --data-urlencode certificate_pem=$(cat secure-cert.pem)" \
     --data-urlencode certificate_key=$(cat secure-key.pem)" \
     https://secure.company.com/system/certificate
```

--------------------------------

### Prepare and mount NFS storage

Source: https://docs.liquidfiles.com/disk_and_storage/using_an_external_nfs_server.html

Move existing data, create the mount point, and mount the external NFS server.

```bash
mv /data /data.old  
mkdir /data  
chown _sfta:_sfta /data  
mount server:/mount/point /data
```

--------------------------------

### View Share API Request

Source: https://docs.liquidfiles.com/api/v4.3/shares/view.html

Example of a GET request to retrieve share details using cURL with an Authorization header.

```bash
curl -X GET -H "Authorization: Bearer nkpIxMK9ucUUE7FvfNpdAf" \
     -H "Accept: application/json" \
     https://test.host/shares/project-alpha
```

--------------------------------

### View Folder Shares GET Request

Source: https://docs.liquidfiles.com/api/v4.3/shares/folders/view.html

Example curl command to retrieve folder details using a bearer token for authentication.

```bash
curl -X GET -H "Authorization: Bearer nkpIxMK9ucUUE7FvfNpdAf" \
     -H "Accept: application/json" \
     https://test.host/shares/project-alpha/folders/goals
```

--------------------------------

### Example XML response from /login

Source: https://docs.liquidfiles.com/deprecated/api_xml/retrieve_api_key.html

Response containing the user's API key in the api_key element.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<user>
  <api_key>4i1Rkf3pkxu0OCRuSuTMqE</api_key>
</user>
```

--------------------------------

### Example Request using cURL

Source: https://docs.liquidfiles.com/deprecated/api_xml/filelink_api.html

A bash script demonstrating how to upload a file to get an attachment ID and then create a FileLink using that ID via cURL.

```bash
#!/bin/bash

# Some nice variables
api_key="Y9fdTmZdv0THButt5ZONIY"
server="https://liquidfiles.example.com"

# Uploading the actual file and get attachment id for each file
attachment_id=`curl -X POST --user "$api_key:x" -F Filedata=@bigfile.zip $server/attachments`

# Send the message
cat <<EOF | curl -s -X POST --user "$api_key:x" -H 'Content-Type: text/xml' -d @- $server/link
<?xml version="1.0" encoding="UTF-8"?>
<link>
  <attachment>$attachment_id</attachment>
</link>
EOF
```

--------------------------------

### Example custom fields configuration

Source: https://docs.liquidfiles.com/filedrops/custom_fields.html

Shows how to define custom fields for a Filedrop. Each line specifies a field with its type, options, and validation. The example includes text, textarea, select, radio, and checkbox fields.

```plaintext
Description: text("Tell us something"), required, validate("[a-zA-Z0-9]{3,}", "Need to contain letters and numbers only.")
Any other comments?: textarea("tell us something else"), required
Print Size: select("Small", "Medium", "*Large"), class("col-lg-2")
Delivery Speed: radio("Slow - when you have some time", "*Medium", "Fast - drop everything and do this now")
Ok to leave at door?: checkbox(checked)
```

--------------------------------

### List FileLinks with curl and example JSON response

Source: https://docs.liquidfiles.com/api/v4.3/filelink

Use this bash script to list FileLinks via a GET request to /link with an optional limit parameter. The response is a JSON array of FileLink objects. The example shows a successful response with two links, including fields like id, filename, size, and URLs.

```bash
#!/bin/bash

# Some nice variables
api_key="Y9fdTmZdv0THButt5ZONIY"
server="https://liquidfiles.example.com"

curl -X GET -H "Authorization: Bearer $api_key" \
     -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     $server/link?limit=2
```

```json
{"links":
  [
    {
      "id":"pOIcoQ1NbJ8Lmp19hd9Vo3",
      "filename":"screenshot.png",
      "send_download_confirmation":true,
      "require_authentication":true,
      "size":147874,
      "size_human":"144 KB",
      "expires_at":"2017-01-03",
      "url":"https://test.host/link/pOIcoQ1NbJ8Lmp19hd9Vo3",
      "created_at":"2016-12-19T21:54:54.000Z",
      "updated_at":"2016-12-19T21:54:54.000Z"
    },
    {
      "id":"ZLa8RSQF2XDyrcVVMbrsNY",
      "filename":"another screenshot.png",
      "send_download_confirmation":true,
      "require_authentication":true,
      "size":147874,
      "size_human":"144 KB",
      "expires_at":"2017-01-03",
      "url":"https://lfapp.dev/link/ZLa8RSQF2XDyrcVVMbrsNY",
      "created_at":"2016-12-19T21:56:08.000Z",
      "updated_at":"2016-12-19T21:56:08.000Z"
    }
  ]
}
```

--------------------------------

### Filedrop Info Request example using curl

Source: https://docs.liquidfiles.com/deprecated/api_xml/sending_files_using_the_filedrop.html

An example of a curl request to fetch Filedrop information and the resulting XML response.

```bash
curl -k -H "Content-Type: text/xml" https://liquidfiles.company.com/filedrop/test_filedrop
<?xml version="1.0" encoding="UTF-8" ?>
<filedrop>
  <api_key>m3Ajg9KdluLTqCK9roqVQ7</api_key>
  <name>Filedrop Test</name>
  <accepted_filetypes>doc, docx, xls, xlsx, ppt, pptx, png, gif, jpg, jpeg, pdf, zip</accepted_filetypes>
  <invalid_extensions></invalid_extensions>
  <max_upload_size type="integer">1000</max_upload_size>
</filedrop>
```

--------------------------------

### View File Shares API - Example Request in JSON

Source: https://docs.liquidfiles.com/api/v4.3/shares/files/view.html

Sends a GET request to the View File Shares API endpoint with Bearer token authentication and Accept: application/json header.

```bash
curl -X GET -H "Authorization: Bearer nkpIxMK9ucUUE7FvfNpdAf" \
     -H "Accept: application/json" \
     https://test.host/shares/project-alpha/folders/goals/files/goals-2017-docx
```
Tokens:
Raw