LiquidFiles Documentation
LiquidFiles Documentation
On This Page

Filedrop Admin API

Available Attributes

The following attributes are available when you're accessing a Filedrop:

Available Attributes
Parameter Type Description
id String The Filedrops unique ID
name String The Filedrop name
title String The Filedrop title
description String The Filedrop description
owner String The user id of the owner of the Filedrop
invalid_extensions String A comma separated list of blocked file extensions.
accepted_filetypes String A comma separated list of file extensions that users will be restricted to using.
expires_after Integer Filedrop downloads expire after this many days.
max_filesize Integer The maximum file size (in MB).
require_validation Boolean True if senders needs to login/validate their email addresses before sending through this Filedrop.
password String If set, users will need to enter this password before accessing this Filedrop.
cc String CC'd email addresses for this Filedrop. Please note that only local users will be able to download files sent with a Filedrop.
authorization Integer The download permission for messages sent using the Filedrop. The available values are:
  • 2: Specified Recipients and local users can download
  • 3: Only Specified Recipients can download

List Filedrop

Request Info
Info Value
Request URL /admin/filedrops
Request VERB GET

Example using curl:

curl -s -X GET --user "37DeYIkmDoQcsl3eEl2lE2:x" -H "Accept: application/json" -H "Content-Type: application/json" https://liquidfiles.company.com/admin/filedrops

[
  {"filedrop":
    {
      "id": "support",
      "name": "support",
      "title": "Support Files",
      "description": "Please upload any required support files.",
      "owner": "joe-user-company-com",
      "invalid_extensions": "",
      "accepted_filetypes": "doc, docx, xls, xlsx, ppt, pptx, png, gif, jpg, jpeg, pdf, zip, ext",
      "expires_after": 14,
      "max_filesize": 1000,
      "require_validation": false,
      "password": "top secret",
      "cc": "",
      "authorization": 3
    }
  }
]

View Filedrop

To view an individual filedrop, please use the following Request:

Request Info
Info Value
Request URL /admin/filedrops/_the_filedrop_ID_
Request VERB GET

Example using curl:

curl -s -X GET --user "37DeYIkmDoQcsl3eEl2lE2:x" -H "Accept: application/json" -H "Content-Type: application/json" https://liquidfiles.company.com/admin/filedrops/support

{"filedrop":
  {
    "id": "support",
    "name": "support",
    "title": "Support Files",
    "description": "Please upload any required support files.",
    "owner": "joe-user-company-com",
    "invalid_extensions": "",
    "accepted_filetypes": "doc, docx, xls, xlsx, ppt, pptx, png, gif, jpg, jpeg, pdf, zip, ext",
    "expires_after": 14,
    "max_filesize": 1000,
    "require_validation": false,
    "password": "",
    "cc": "",
    "authorization": 3
  }
}

Create Filedrop

Request Info
Info Value
Request URL /admin/filedrops
Request VERB POST
Parameters
Parameter Type Description
The name, title and owner are the only required parameters, please see the Attributes section near the top for all available parameters.
name String The name of the Filedrop
title String The title for the Filedrop
owner String The user id of the owner of the Filedrop

As a reponse, you will receive the user object with the attributes as listed in the users attribute section above.

Example using curl:
cat <<EOF | curl -s -X POST --user "37DeYIkmDoQcsl3eEl2lE2:x" -H "Accept: application/json" -H "Content-Type: application/json" -d @- https://liquidfiles.company.com/admin/filedrops
{"filedrop":
  {
    "name": "Partner-Drop",
    "owner": "some-local-user-company-com",
    "title": "Partner Filedrop"
  }
}
EOF

{"filedrop":
  {
    "id": "Partner-Drop",
    "name": "Partner-Drop",
    "title": "Partner Filedrop",
    "description": "",
    "owner": "some-local-user-company-com",
    "invalid_extensions": "",
    "accepted_filetypes": "doc, docx, xls, xlsx, ppt, pptx, png, gif, jpg, jpeg, pdf, zip, ext",
    "expires_after": 14,
    "max_filesize": 250,
    "require_validation": false,
    "password": "",
    "cc": "",
    "authorization": 3
  }
}

Update Filedrop

Request Info
Info Value
Request URL /admin/filedrops/_the_filedrop_ID_
Request VERB PUT
Parameters
Parameter Type Description
There are no required parameters, please see the Attributes section near the top for all available parameters.

As a reponse, you will receive the Filedrop object with the attributes as listed in the users attribute section above.

Example using curl:
cat <<EOF | curl -s -X PUT --user "37DeYIkmDoQcsl3eEl2lE2:x" -H "Accept: application/json" -H "Content-Type: application/json" -d @- https://liquidfiles.company.com/admin/filedrops/Partner-Drop
{"filedrop":
  {
    "title": "New Partner Filedrop Name",
    "expires_after": 24
  }
}
EOF

{"filedrop":
  {
    "id": "Partner-Drop",
    "name": "Partner-Drop",
    "title": "New Partner Filedrop Name",
    "description": "",
    "owner": "some-local-user-company-com",
    "invalid_extensions": "",
    "accepted_filetypes": "doc, docx, xls, xlsx, ppt, pptx, png, gif, jpg, jpeg, pdf, zip, ext",
    "expires_after": 24,
    "max_filesize": 250,
    "require_validation": false,
    "password": "",
    "cc": "",
    "authorization": 3
  }
}

Delete Filedrop

Request Info
Info Value
Request URL /admin/filedrops/_the_filedrop_ID_
Request VERB DELETE

The response will be blank, with a http status code of 200 if the Filedrop was deleted.

Example using curl:
curl -s -X DELETE --user "ayFlT3BNx1OXxiZcM4h5Tl:x" -H "Accept: application/json" -H "Content-Type: application/json" https://liquidfiles.company.com/admin/filedrops/Partner-Drop