Fortinet white logo
Fortinet white logo

Rest API

7.4.0

Get /host/device-profiling-rule

Get /host/device-profiling-rule

Description

Returns all Device Profiling Rule 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/host/device-profiling-rule

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "string",

"errorMessage": "string",

"results": [

{

"landscape": 0,

"id": 0,

"name": "string",

"type": {

"name": "string",

"tag": "string",

"imageFile": "string",

"id": 0

},

"notify": true,

"registerAutomatically": true,

"registerClient": true,

"registerToLoggedInUser": true,

"role": "string",

"addToGroup": true,

"groupId": 0,

"addToDomain": true,

"domainId": 0,

"state": "string",

"version": 0,

"rank": 0,

"enabled": true,

"methods": [

{

"enabled": true,

"methodType": {

"id": 0,

"name": "string",

"shortName": "string"

},

"version": 0,

"encrypted": true,

"priority": 0,

"methodTypeString": "string"

}

],

"description": "string",

"sponsorNote": "string",

"weeklySchedule": {

"version": 0,

"startTimeOfDay": 0,

"endTimeOfDay": 0,

"daysOfWeek": 0,

"validTime": true,

"alwaysOn": true,

"startTimeOfDayAM": true,

"endTimeOfDayAM": true,

"startTimeOfDayHours": 0,

"endTimeOfDayHours": 0,

"startTimeOfDayMinutes": 0,

"endTimeOfDayMinutes": 0

},

"reValidation": true,

"reValidationInterval": 0,

"failedValidationAction": {

"disable": true,

"version": 0

},

"lastModifiedBy": "string",

"lastModifiedDate": "2024-02-27T23:59:17.572Z",

"guid": 0,

"globalModifiedDate": "2024-02-27T23:59:17.572Z",

"registerToUser": "string",

"tags": [

"string"

],

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"modifyAuditSummary": "string",

"addAuditSummary": "string",

"catchAll": true,

"methodSummaryString": "string"

}

],

"filtered": 0,

"total": 0

}

Get /host/device-profiling-rule

Get /host/device-profiling-rule

Description

Returns all Device Profiling Rule 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/host/device-profiling-rule

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "string",

"errorMessage": "string",

"results": [

{

"landscape": 0,

"id": 0,

"name": "string",

"type": {

"name": "string",

"tag": "string",

"imageFile": "string",

"id": 0

},

"notify": true,

"registerAutomatically": true,

"registerClient": true,

"registerToLoggedInUser": true,

"role": "string",

"addToGroup": true,

"groupId": 0,

"addToDomain": true,

"domainId": 0,

"state": "string",

"version": 0,

"rank": 0,

"enabled": true,

"methods": [

{

"enabled": true,

"methodType": {

"id": 0,

"name": "string",

"shortName": "string"

},

"version": 0,

"encrypted": true,

"priority": 0,

"methodTypeString": "string"

}

],

"description": "string",

"sponsorNote": "string",

"weeklySchedule": {

"version": 0,

"startTimeOfDay": 0,

"endTimeOfDay": 0,

"daysOfWeek": 0,

"validTime": true,

"alwaysOn": true,

"startTimeOfDayAM": true,

"endTimeOfDayAM": true,

"startTimeOfDayHours": 0,

"endTimeOfDayHours": 0,

"startTimeOfDayMinutes": 0,

"endTimeOfDayMinutes": 0

},

"reValidation": true,

"reValidationInterval": 0,

"failedValidationAction": {

"disable": true,

"version": 0

},

"lastModifiedBy": "string",

"lastModifiedDate": "2024-02-27T23:59:17.572Z",

"guid": 0,

"globalModifiedDate": "2024-02-27T23:59:17.572Z",

"registerToUser": "string",

"tags": [

"string"

],

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"modifyAuditSummary": "string",

"addAuditSummary": "string",

"catchAll": true,

"methodSummaryString": "string"

}

],

"filtered": 0,

"total": 0

}