| Target URL | /api.php/Drive/files/weblink |
| Required scope | weblink |
| HTTP Method | POST |
| Output format | JSON |
Request Parameters Reference
| Parameter | Type | Description |
|---|---|---|
| path | string | The FileRun path of the target file/folder. |
| password | string | |
| expiry | datetime | MySQL datetime format Y-m-d H:i:s |
| download_limit | integer | |
| download_terms | string | |
| role | string | One of the following: viewercommentereditoruploader |
| require_login | boolean | Only logged in FileRun users will be able to access the link. |
Example reply:
1{
2 "success": true,
3 "status": "created", //can also return "updated",
4 "url": "https:\/\/www.yoursite.com\/wl\/?id=CtmsT8IWoen3JDZIVbxvR3SH45gvvvxs"
5}