REST API Calls

Below is a list of common REST API calls. Refer to the zipped files in REST API Reference for details and Configuring REST Permission Roles for details of assigning REST permissions.

• User-specific REST API:

  • Get user

  • Update user

  • Delete user

  • Create user

  • Get user stats (counters such as last modified time, last connected, etc.)

• VFS and Folder-specific REST API:

  • Get a user’s home directory

  • Create a folder

  • Create a virtual folder

  • Rename folder

  • Retarget a virtual folder

  • Delete folder

  • Edit folder permissions

• Event Rule-specific REST API:

  • Get Event Rule ID by Name

  • Delete Event Rule

  • Edit Event Rule

  • Create Event Rule

Certain calls within other features, such as user or event rules, must be made before calling another feature. For example, if you want to get a user ID, you:

1. Authenticate on EFT;

2. Query the sitelist to get the site ids (part of the Site REST API);

3. Query the user list get the user IDs.