https://man.liquidfiles.com
LiquidFiles Documentation
Please note that the Pools Admin API require at least LiquidFiles v2.5 and are only enabled with a LiquidFiles license

The Pools Admin API will enable you to add, delete and update Pools on the LiquidFiles system.

Available Attributes

The following attributes are available when you're accessing the Pools Admin API:

id                           # String.  The Pools unique ID.
name # String. The Pools name.
groups # Array. An Array of all group ID's that has access to this Pool.
attachments # Array. An Array of all attachment's that are available in this Pool.
created_at # DateTime The Date and Time when the Pool was created.
updated_at # DateTime The Date and Time when the Pool was last updated.

List Pools

Request

Request URL: /admin/pools
Request VERB: GET

As a response, you will get an array of pools with the attributes as listed in the available attributes section above.

Example using curl:

curl -s -X GET --user "37DeYIkmDoQcsl3eEl2lE2:x" -H 'Content-Type: application/json' https://liquidfiles.company.com/admin/pools
[
  {"pool":
   {
     "id": "support-files",
     "name": "Support Files",
"created_at": "2014-06-29 07:27:02 UTC",
"updated_at": "2014-08-07 00:44:34 UTC",
     "groups": ["sysadmins","admins","local-users"],
"attachments": [
{"attachment":
{
"id": "fLBLbDFtyRQJCIkyB05p7h",
"pool_id": "support-files",
"user_id": "",
"filename": "SupportFiles.zip",
"size": 53516232,
"content_type": "application/octet-stream",
"checksum": "5c59ef6f86b878cac23fee21498e192d2247d988",
"crc32": "acb7c906"
}
}
]
   }
}
]

View Pool

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

Request

Request URL: /admin/pools/_the_pool_ID_
Request VERB: GET

Example using curl:

curl -s -X GET --user "37DeYIkmDoQcsl3eEl2lE2:x" -H 'Content-Type: application/json' https://liquidfiles.company.com/admin/pools/support-files
{"pool": { "id": "support-files", "name": "Support Files", "created_at": "2014-06-29 07:27:02 UTC", "updated_at": "2014-08-07 00:44:34 UTC", "groups": ["sysadmins","admins","local-users"], "attachments": [ {"attachment": { "id": "fLBLbDFtyRQJCIkyB05p7h", "pool_id": "support-files", "user_id": "", "filename": "SupportFiles.zip", "size": 53516232, "content_type": "application/octet-stream", "checksum": "5c59ef6f86b878cac23fee21498e192d2247d988", "crc32": "acb7c906" } } ] } }

Create Pool

Request

Request URL: /admin/pools
Request VERB: POST
Parameters:
pool:
name # String. The name of the Pool.
groups # Array. Group ID's of groups that will have access to this pool.

Please note, you can manage attachments with different API calls further down.

As a reponse, you will receive the Pool 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 'Content-Type: application/json' -d @- https://liquidfiles.company.com/admin/pools
{"pool":
  {
    "name": "Partner Pool",
"groups": ["sysadmins", "admins", "local-users"]
}
}
EOF
{"pool": { "id": "partner-pool", "name": "Partner Pool", "created_at": "2014-06-29 07:27:02 UTC", "updated_at": "2014-08-07 00:44:34 UTC", "groups": ["sysadmins","admins","local-users"], "attachments": [] } }

Update Pool

Request

Request URL: /admin/pools/_the_pool_ID_
Request VERB: PUT
Parameters:
pool:
name                       # String.  The name of the Pool.
groups                     # Array.   Group ID's of groups that will have access to this pool.

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

Example using curl:

cat <<EOF | curl -s -X PUT --user "37DeYIkmDoQcsl3eEl2lE2:x" -H 'Content-Type: application/json' -d @- https://liquidfiles.company.com/admin/pools/partner-pool
{"pool":
  {
"groups": ["admins","local-users"]
}
}
EOF
{"pool": { "id": "partner-pool", "name": "Partner Pool", "created_at": "2014-06-29 07:27:02 UTC", "updated_at": "2014-08-07 00:44:34 UTC", "groups": ["admins","local-users"], "attachments": [] } }

Delete Pool

Request

Request URL: /admin/pools/_the_pool_ID_
Request VERB: DELETE

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

Example using curl:

curl -s -X DELETE --user "ayFlT3BNx1OXxiZcM4h5Tl:x" -H 'Content-Type: application/json' https://liquidfiles.company.com/admin/pools/partner-pool

Adding files to a Pool

To add files to a pool, please see the Attachments API.

Removing files from a Pool

Request

Request URL: /admin/pools/_the_pool_ID_/delete_attachment/_the_attachment_ID_
Request VERB: DELETE

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

Example using curl:

curl -s -X DELETE --user "ayFlT3BNx1OXxiZcM4h5Tl:x" -H 'Content-Type: application/json' https://liquidfiles.company.com/admin/pools/partner-pool/delete_attachment/8cvrfQ6zSQhLccJnKGzSV5