API: Starring files or folders
| Target URL (add) | /api.php/Drive/files/star |
| Target URL (remove) | /api.php/Drive/files/unstar |
| Required scope | modify |
| HTTP Method | GET/POST |
| Output format | JSON |
Request Parameters Reference
| Parameter | Type | Description |
|---|---|---|
| path | string | The FileRun path of the target file/folder. See this page |
Starring and unstarring require the permission to download and, since FileRun 2026.4.0, the permission to star files and folders (starring). Before, they required the permission to make changes. Items reached through a web link cannot be starred. Starring an item which is already starred is refused ("It is already starred!").
The starred items are listed at /ROOT/STARRED, and the hasStar detail of the listing endpoint tells whether an item is starred.