Fortinet black logo

Administration Guide

Specific scheduled task

Copy Link
Copy Doc ID 825689eb-200d-11e9-b6f6-f8bc1258b856:732261
Download PDF

Retrieve a specific scheduled task.

https://<servername>:8443/api/scheduler/{id}

Return value

Type

Description

id

Integer

Scheduled task record ID

hidden

boolean

Is task for internal use only.

paused

boolean

Is task paused.

previousScheduledTime

String

Last time task ran.

scheduledTime

String

Next time task scheduled to run

name

String

Name of scheduled task.

Example request

curl -k -u '<username>:<password>' -H "accept: application/xml" -X GET https://<servername>:8443/api/scheduler/1

Example XML format

<schedulerResult>

<status>success</status>

<errorMessage></errorMessage>

<schedule>

<hidden>false</hidden>

<id>1</id>

<name>Auto-Definition Synchronizer</name>

<paused>false</paused>

<previousScheduledTime>2017-01-23T10:45:22.326-05:00</previousScheduledTime>

<scheduledTime>2017-01-30T10:45:59.681-05:00</scheduledTime>

</schedule>

</schedulerResult>

Retrieve a specific scheduled task.

https://<servername>:8443/api/scheduler/{id}

Return value

Type

Description

id

Integer

Scheduled task record ID

hidden

boolean

Is task for internal use only.

paused

boolean

Is task paused.

previousScheduledTime

String

Last time task ran.

scheduledTime

String

Next time task scheduled to run

name

String

Name of scheduled task.

Example request

curl -k -u '<username>:<password>' -H "accept: application/xml" -X GET https://<servername>:8443/api/scheduler/1

Example XML format

<schedulerResult>

<status>success</status>

<errorMessage></errorMessage>

<schedule>

<hidden>false</hidden>

<id>1</id>

<name>Auto-Definition Synchronizer</name>

<paused>false</paused>

<previousScheduledTime>2017-01-23T10:45:22.326-05:00</previousScheduledTime>

<scheduledTime>2017-01-30T10:45:59.681-05:00</scheduledTime>

</schedule>

</schedulerResult>