Actions supported by the Folders API

Action: create

This action is for creating and setting up a folder on the server. It's possible to create a completely new folder or let the server sync a folder which already exists on a client or on a different server (by folder ID).

Example

https://powerfolder.example.com/api/folders?action=create&name=Sales%20Material&path=D%3A%5CData%5CSales%20Material

{
 "ID":"[PME2myosRegfgKk8m0YdIA]",
 "message":"Successfully created folder Sales Material"
}

Action: delete

This action is for deleting a folder and removing all user's permissions from it.

Example

https://powerfolder.example.com/api/folders?action=delete&ID=%5BPME2myosRegfgKk8m0YdIA%5D

{
 "ID":"[PME2myosRegfgKk8m0YdIA]",
 "message":"Successfully deleted folder Sales Material. Removed 3 members."
}

Action: setPermission

This action is for adding and removing users to/from a folder. With this method it is also possible to change access permission of users on folders. Does NOT sent an invitation E-Mail!

 Make sure to URL-encode the parameter values.

Example

https://powerfolder.example.com/api/folders?action=setPermission&username=user%40example.com&ID=%5BPME2myosRegfgKk8m0YdIA%5D&permission=READ

{
 "message":"Set new permission for user@example.com on Sales Material to READ",
 "ID":"[PME2myosRegfgKk8m0YdIA]"
}

Action: invite

This action invites a user to a folder. An invitation E-Mail is sent to the user.

Make sure to URL-encode the parameter values.

Example

https://powerfolder.example.com/api/folders?action=invite&username=user%40example.com&ID=%5BPME2myosRegfgKk8m0YdIA%5D&permission=READ

{
 "message":"Send invite to user@example.com for Sales Material to grant READ",
 "ID":"[PME2myosRegfgKk8m0YdIA]"
}

Action: getInfo

This action returns some general information about a folder.

Example

https://powerfolder.example.com/api/folders?action=getInfo&ID=%5BPME2myosRegfgKk8m0YdIA%5D

{
  "ID":"[PME2myosRegfgKk8m0YdIA]",
  "name":"Sales Documents",
  "basePath":"/storage/Sales Documents",
  "link":"https://powerfolder.example.com/getlink/fiVej3G7AL553BthR8FJyoVK/",
  "isPublic":true
}

Action: getAccounts

This action returns all users accounts of a folder. 

Example

https://powerfolder.example.com/api/folders?action=getAccounts&ID=%5BPME2myosRegfgKk8m0YdIA%5D

{
  "ResultSet":{
     "Result":[
        {
           "ID":"3GYXgyusXuNoHd88qgWp",
           "username":"manager@example.com",
           "permission":"OWNER"
        },
        {
           "ID":"Tb2yMiAx3CuRrqMeccHh",
           "username":"employee@example.com",
           "permission":"ADMIN"
        },
        {
           "ID":"Xr2Ajd235MeccHh",
           "username":"customer@example.net",
           "permission":"READ"
        }
     ]
  }
}

Action: removeAllAccounts

This action will remove all users from a folder, by revoking their access permissions including the owner. It will not remove the folder itself.

 Make sure to URL-encode the parameter values.

Example

https://powerfolder.example.com/api/folders?action=removeAllAccounts&ID=%5BPME2myosRegfgKk8m0YdIA%5D

{
"message":"Revoked all permissions for 3 users on folder Sales Material",
"ID":"[PME2myosRegfgKk8m0YdIA]"
}

Action: rename

This action will rename a Folder specified by its ID to the given name.

 Make sure to URL-encode the parameter values.

Example

https://powerfolder.example.com/api/folders?action=rename&ID=%5BPME2myosRegfgKk8m0YdIA%5D&newName=Sales%20Material

Return Value

{
"message":"Folder successfully renamed",
"newName":"Sales Material"
}