Run Task Now: task_run_now
|
Service name: task_run_now |
|
|
URL |
https://SERVER/api/?apikey=yourAPItoken&service=task_run_now &required_parameters=required_parameters [&optional_parameters=optional_parameters] |
|
Description |
Set an Automated Task to run now and return the time until the task starts. |
|
Parameters |
|||||
|
Post Variable |
Description |
Type |
Required |
Options |
Default |
|
Optional. Returns a description of the service. |
boolean |
no |
true |
0 |
|
|
checkid |
The identifier for the Automated Task |
number |
yes |
0 |
0 |
|
Example Service Call - task_run_now |
|
https://SERVER/api/?apikey=yourAPItoken&service=task_run_now&checkid=CHECKID |
|
Example Response |
<?xml version="1.0" ?> <result created="2012-04-26T18:30:04+01:00" host="SERVER" status="OK"> <message time="15">15 minutes</message> </result> |
|
Fields Description |
|||
|
Field |
Type |
Can Be Empty |
Description |
|
@time |
string |
no |
Number of minutes until Automated Task runs |
|
message |
string |
no |
Textual representation of time until Automated Task run |
| Example Associated Service Calls | ||
| Parameter | Call | URL Format |
| CheckID | list_checks | https://SERVER/api/?apikey=yourAPItoken&service=list_checks&deviceid=DEVICEID |
| DeviceID | list_devices_at_client |
https://SERVER/api/?apikey=yourAPItoken&service=list_devices_at_client&clientid=CLIENTID&devicetype=server |
| list_servers |
https://SERVER/api/?apikey=yourAPItoken&service=list_servers&siteid=SITEID |
|
| list_workstations |
https://SERVER/api/?apikey=yourAPItoken&service=list_workstations&siteid=SITEID |
|
| SiteID | list_sites | https://SERVER/api/?apikey=yourAPItoken&service=list_sites&clientid=CLIENTID |
| ClientID | list_clients | https://SERVER/api/?apikey=yourAPItoken&service=list_clients |