| Target URL | /api.php/files/share/ |
| Required scope | share |
| HTTP Method | GET/POST |
| Output format | JSON |
Request Parameters Reference
| Parameter | Type | Required | Description |
|---|---|---|---|
| path | string | Yes | The FileRun path of the file or the folder. |
| uid | integer | Yes if no "gid" or "name" + "email" | ID of FileRun user to share folder with. |
| gid | integer | Yes if no "uid" or "name" + "email" | ID of FileRun group to share folder with. |
| name | string | Yes if no "gid" or "uid" | Name of guest user to add and share with. |
| string | Yes if no "gid" or "uid" | E-mail address of guest user to add and share with. | |
| anonymous | boolean | No | Specify if folder is to be shared anonymously. |
| upload | boolean | No | Specify if upload permission is granted. |
| download | boolean | No | Specify if download permission is granted. |
| comment | boolean | No | Specify if the permission to post comments is granted. |
| read_comments | boolean | No | Specify if the permission to read comments is granted. |
| alter | boolean | No | Specify if the permission to make file changes is granted. |
| share | boolean | No | Specify if the permission to share files using web links or via e-mail is granted. |
| alias | string | No | Specify an alias for the shared folder name. Does not apply to sharing files. |
Note: If the file or folder was already shared, the share settings will be updated. No errors will be returned in that case.