-
Notifications
You must be signed in to change notification settings - Fork 51
Download Station API
Quentin Rousseau edited this page Feb 16, 2015
·
1 revision
The DownloadStation API is an AuthenticatedAPI, that means the user needs to be authenticated before using this API.
Fortunately, the AuthenticatedAPI is smart enough to automatically log the user.
The syno object uses the dl (or downloadStation alias) property to interact with the DownloadStation API.
Get/Set DownloadStation information and configuration.
| Method Name | Description | Required params |
|---|---|---|
getDownloadStationInfo(callback) |
Get DownloadStation information | - |
getDownloadStationConfig(callback) |
Get DownloadStation configuration | - |
setDownloadStationConfig(params, callback) |
Set DownloadStation configuration | - |
Get/Set Schedule configuration.
| Method Name | Description | Required params |
|---|---|---|
getScheduleConfig(callback) |
Get Schedule configuration | - |
setScheduleConfig(params, callback) |
Set Schedule configuration | - |
Tasks management.
| Method Name | Description | Required params |
|---|---|---|
listTasks(params, callback) |
List download tasks | - |
getTasksInfo(params, callback) |
Get download task information | id |
createTask(params, callback) |
Create a download task | - |
deleteTasks(params, callback) |
Delete one or more download tasks | id |
pauseTasks(params, callback) |
Pause one or more tasks | id |
resumeTasks(params, callback) |
Resume one or more tasks | id |
editTasks(params, callback) |
Edit one or more tasks | id |
Statistics management.
| Method Name | Description | Required params |
|---|---|---|
getStats(callback) |
Get stats | - |
RSS Sites management.
| Method Name | Description | Required params |
|---|---|---|
listRSSSites(params, callback) |
List RSS sites | - |
refreshRSSSites(params, callback) |
Refresh RSS sites | id |
RSS Feed management.
| Method Name | Description | Required params |
|---|---|---|
listRSSFeeds(params, callback) |
List RSS feeds | id |
Torrent search management.
| Method Name | Description | Required params |
|---|---|---|
startBTSearch(params, callback) |
Start a BTSearch |
keyword module
|
listBTSearch(params, callback) |
List BTSearch | taskid |
getBTSearchCategories(callback) |
Get BTSearch categories | - |
cleanBTSearch(params, callback) |
Clean BTSearch | taskid |
getBTSearchModules(callback) |
Get BTSearch modules | - |