Scheduler
addTask | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=scheduler&action=addTask | ||||||||||||||||||||||||||||||||
Description | Add a new scheduled task. Request is POST-only. Params are a single JSON object: | ||||||||||||||||||||||||||||||||
Returns | Examples: SUCCESSFUL: {"success":1,"message":"Message "} ERROR: {"success":0, "message":"Error Message"}> | ||||||||||||||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||||||||||||||
Optional Parameters |
|
updateTask | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=scheduler&action=updateTask | ||||||||||||||||||||||||||||||||
Description | Update a scheduler task | ||||||||||||||||||||||||||||||||
Returns | Examples: SUCCESSFUL: {"success":1,"message":"Message"} ERROR: {"success":0, "message":"Error Message"}> | ||||||||||||||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||||||||||||||
Optional Parameters |
|
deleteTask | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=scheduler&action=deleteTask | ||||||||
Description | Delete a scheduler task | ||||||||
Returns | Examples: SUCCESSFUL: {"success":1,"message":"Task \"New Task\" (2) deleted","data":null} ERROR: {"success":0, "message":"Error Message"}> | ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
Example URL | /api/v1/api.php?target=scheduler&action=deleteTask&taskId=2 |
executeTask | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=scheduler&action=executeTask | ||||||||
Description | Execute a task immediately | ||||||||
Returns | Examples: SUCCESSFUL: {"success":1,"message":"Holding tank processed. 0 IPv4 and 0 IPv6 blocks moved to the available pool. ","data":null} ERROR: {"success":0, "message":"Error Message"}> | ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
Example URL | /api/v1/api.php?target=scheduler&action=executeTask&taskId=1 |
getTaskHistory | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=scheduler&action=getTaskHistory | ||||||||
Description | Get history for a specific task | ||||||||
Returns | Examples: SUCCESSFUL: { "success": 1, "data": [ { "log_id": "1005037", "time": "2015-05-07 12:29:45", "log_level": "6", "user_id": "31", "username": "usernamehere", "log_category": "System", "message": "task_id=1 task=Process Holding Tank action=finished message=Holding tank processed. 0 IPv4 and 0 IPv6 blocks moved to the available pool.", "ip": null }, { "log_id": "1005033", "time": "2015-05-07 12:28:50", "log_level": "6", "user_id": "31", "username": "usernamehere", "log_category": "System", "message": "task_id=1 task=Process Holding Tank action=finished message=Holding tank processed. 1 IPv4 and 0 IPv6 blocks moved to the available pool.", "ip": null }, { "log_id": "1005030", "time": "2015-05-07 12:28:14", "log_level": "6", "user_id": "31", "username": "usernamehere", "log_category": "System", "message": "Task \"Process Holding Tank\" (1) added", "ip": null } ] } ERROR: {"success":0, "message":"Error Message"}> | ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
Example URL | /api/v1/api.php?target=scheduler&action=getTaskHistory&taskId=1 |
getTasks | |
---|---|
URL | /api/v1/api.php?target=scheduler&action=getTasks |
Description | Gets a list of scheduled tasks and their repeat settings |
Returns | Examples: |
Required Parameters | None |
Optional Parameters | None |
Example URL | /api/v1/api.php?target=scheduler&action=getTasks |