https://man.liquidfiles.com
LiquidFiles Documentation

List Request

This Request lists all available shares in the system

Request Info
Info Value
Request URL /admin/shares
Request VERB GET
Response Parameters
Parameter Type Description
id String The ID of the specific share.
name String The name of the Share.
revisions Integer How many old versions of files should be kept when a file is overwritten or updated.
quota Integer How many MegaBytes that has been allocated for this share.
created_at DateTime When the share was created.
updated_at DateTime When the share was last updated.
accesses Array

An Array of Users and Groups with access to this Share, with the following attributes:

  • ID: The User or Group ID.
  • Type: Either User or Group.
  • read_only: If the user or group has read-only access.
  • write: If the user or group has read/write access. Read-only and write are mutually exclusive. If a user or group has write access, they cannot have read-only access, and vise versa.
  • view_log: If the user or group can view the share log.

Example Request Using Curl

curl -X GET -H 'Content-Type: application/json' --user nkpIxMK9ucUUE7FvfNpdAf:x https://test.host/admin/shares

Example Response

{"shares":
  [
    {
      "id":"alpha",
      "name":"Project Alpha",
      "revisions":3,
      "quota":1000,
      "created_at":"2016-02-01T09:11:23.000Z",
      "updated_at":"2016-09-29T10:54:02.000Z",
      "accesses":[
        {
          "id":"user-mycompany-com",
          "type":"User",
          "read_only":true,
          "write":false,
          "view_log":true
        },
        {
          "id":"sysadmins",
          "type":"Group",
          "read_only":false,
          "write":true,
          "view_log":true
        }
      ]
    }
  ]
}

View Request

This Request views an individual share.

Request Info
Info Value
Request URL /admin/shares/_the_share_id_
Request VERB GET

The Response Parameters are the same as for the List action above.

Example Request Using Curl

curl -X GET -H 'Content-Type: application/json' --user nkpIxMK9ucUUE7FvfNpdAf:x https://test.host/admin/shares/alpha

Example Response

{"share":
  {
    "id":"alpha",
    "name":"Project Alpha",
    "revisions":3,
    "quota":1000,
    "created_at":"2016-02-01T09:11:23.000Z",
    "updated_at":"2016-09-29T10:54:02.000Z",
    "accesses":[
      {
        "id":"user-mycompany-com",
        "type":"User",
        "read_only":true,
        "write":false,
        "view_log":true
      }
    ]
  }
}