Fortinet white logo
Fortinet white logo

Rest API

7.4.0

Get /system/scheduler

Get /system/scheduler

Description

Returns all scheduled task records which match the supplied filter.

Request Headers

Key

Value

Type

Description

Authorization Bearer <Authorization Token> String Authorization credential generated by FortiNAC
Content-Type (option 1) application/json String

Content-Type (option 2)

application/xml

Request Body Parameters

Name

Required

Type

filter Optional Array
start Optional Integer
count Optional Integer
sortKey Optional String
sortDir Optional String

Sample Request

Request URL

Get https://10.106.94.152:8443/api/v2/system/scheduler

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "string",

"errorMessage": "string",

"results": [

{

"eventTag": "string",

"type": "string",

"hidden": true,

"description": {

"description": "string",

"targets": "string",

"cmdLabel": "string",

"actionValue": "string",

"actionLabel": "string",

"cmdValue": "string",

"version": 0

},

"internalObject": {},

"taskTag": "string",

"multyDay": {

"days": {

"additionalProp1": {},

"additionalProp2": {},

"additionalProp3": {}

},

"version": 0

},

"scheduledTaskEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-01-31T00:16:37.195Z",

"version": 0,

"time": 0,

"eventFormatString": "string",

"empty": true

},

"period": 0,

"previousScheduledTime": "2024-01-31T00:16:37.196Z",

"scheduledTime": "2024-01-31T00:16:37.196Z",

"pause": true,

"name": "string",

"state": "string",

"id": 0,

"landscape": 0,

"version": 0

}

],

"filtered": 0,

"total": 0

}

Get /system/scheduler

Get /system/scheduler

Description

Returns all scheduled task records which match the supplied filter.

Request Headers

Key

Value

Type

Description

Authorization Bearer <Authorization Token> String Authorization credential generated by FortiNAC
Content-Type (option 1) application/json String

Content-Type (option 2)

application/xml

Request Body Parameters

Name

Required

Type

filter Optional Array
start Optional Integer
count Optional Integer
sortKey Optional String
sortDir Optional String

Sample Request

Request URL

Get https://10.106.94.152:8443/api/v2/system/scheduler

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "string",

"errorMessage": "string",

"results": [

{

"eventTag": "string",

"type": "string",

"hidden": true,

"description": {

"description": "string",

"targets": "string",

"cmdLabel": "string",

"actionValue": "string",

"actionLabel": "string",

"cmdValue": "string",

"version": 0

},

"internalObject": {},

"taskTag": "string",

"multyDay": {

"days": {

"additionalProp1": {},

"additionalProp2": {},

"additionalProp3": {}

},

"version": 0

},

"scheduledTaskEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-01-31T00:16:37.195Z",

"version": 0,

"time": 0,

"eventFormatString": "string",

"empty": true

},

"period": 0,

"previousScheduledTime": "2024-01-31T00:16:37.196Z",

"scheduledTime": "2024-01-31T00:16:37.196Z",

"pause": true,

"name": "string",

"state": "string",

"id": 0,

"landscape": 0,

"version": 0

}

],

"filtered": 0,

"total": 0

}