A folder is a file system container for other files and folders in a volume. The iHub system identifies a folder by a folder ID number, which is unique on each volume. The REST API uses file ID numbers for most requests. Users have explicit privileges to different folders. The /folders resource provides users access to files and folders, enables them to add, modify, or remove folders, and allows them to change folder privileges. iHub restricts these abilities based on a user’s privileges and access rights.

The following sections provide an example of using each folders resource as a curl command and detailed information about the response returned by the resource.

This example requests the list of files and folders in the root folder of the volume, returning two items per response:

This curl example requests the list of files and folders in the root folder of the default volume, returning two items per response:

This example requests the details for the folder with the folder ID 640000000100:

This curl example requests the details of the folder with the folder ID 640000000100 in the default volume:

This example requests the contents of the folder with the folder ID 640000000100 using the HTTPS protocol:

This curl example requests the contents of the folder with the folder ID 640000000100 in the default volume:

The following URI requests the privileges assigned to folder ID 340000000100 when accompanied by a GET method:

This curl example requests the ACL for the folder with the folder ID 340000000100 in the default volume:

The following HTTP request changes the privileges on the folder with folder ID 340000000100 for the mrfox user and the dahl user group:

This curl POST request example changes the ACL of the folder with the folder ID 340000000100 to the ACL in foldersprivsparams.txt:

This HTTP POST request example creates a new subfolder called Customers in the folder with the folder ID 340000000100:

This curl POST request example creates a subfolder named Customers in the folder with the folder ID 340000000100 of the default volume:

This example deletes the folder with the folder ID 70000000100:

This curl DELETE request example deletes the folder with the folder ID 70000000100 from the default volume:

The following HTTP request changes the name and path of the folder with folder ID 340000000100 to /Public/Application1:

This curl PUT request example changes the name and path of the folder with the folder ID 340000000100 to /Public/Application1 in the default volume: