Fortinet white logo
Fortinet white logo

Rest API

7.4.0

Get /policy/endpoint-compliance-configuration

Get /policy/endpoint-compliance-configuration

Description

Returns a list of Endpoint Compliance Configuration records matching 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/policy/endpoint-compliance-configuration

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "success",

"errorMessage": null,

"results": [

{

"name": "Virus Can",

"note": "",

"agents": {

"WINDOWS_CE": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"OPENBSD": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"SOLARIS": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"Mac-OS-X": "b8a94e0a-91b9-4f83-9fba-601b04d8fe20",

"Windows": "b8a94e0a-91b9-4f83-9fba-601b04d8fe20",

"Any": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"APPLE_IOS_IPAD": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"RIM_TABLET_OS": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"CHROME_OS": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"WINDOWS_RT": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"FREEBSD": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"KINDLE": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"APPLE_IOS_IPOD": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"LINUX_OTHER": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"APPLE_IOS": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"WEBOS": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"Linux": "b8a94e0a-91b9-4f83-9fba-601b04d8fe20",

"BLACKBERRY_10": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"LINUX_x86": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"APPLE_IOS_IPHONE": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"NETBSD": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"SYMBIAN": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"ANDROID": "dee7da73-46cd-40b1-8bbf-b39ca0bc1b5e",

"BLACKBERRY_OS": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"WINDOWS_PHONE": "3255ea97-14ad-432a-b2b4-fa4332aba950"

},

"actions": {},

"profileID": 2,

"scriptProfile": {

"lastModifiedBy": "",

"lastModifiedDate": "1970-01-01T00:00:00.000+0000",

"lastChangeSummary": "",

"name": "OS-Anti-Virus-Check",

"guid": -1,

"globalModifiedDate": "1970-01-01T00:00:00.000+0000",

"scriptType": 0,

"entityType": 7,

"groupID": -1,

"id": 2,

"state": 0,

"renewIP": false,

"scanRogue": true,

"registerFailedRogue": false,

"scanOnConnect": false,

"auditOnly": false,

"elapsedNumberOfDays": 0,

"jailbreakThreshold": -1,

"rootThreshold": -1,

"auditObjectName": "OS-Anti-Virus-Check",

"auditObjectType": {

"auditTableName": "SCRIPTPROFILEAudit",

"mysqlTableName": "SCRIPTPROFILE",

"idnameQuery": "select id,name from SCRIPTPROFILE where id in"

},

"modifyAuditSummary": "",

"addAuditSummary": "",

"policyHash": -1997650250,

"timeToWait": 120,

"allAgentUUIDs": []

},

"appCollectionEnabled": false,

"agentAndroid": "dee7da73-46cd-40b1-8bbf-b39ca0bc1b5e",

"agentIOSUnknown": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"agentIOSIPad": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"agentIOSIPhone": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"agentIOSIPod": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"agentLinux": "b8a94e0a-91b9-4f83-9fba-601b04d8fe20",

"agentMacOSX": "b8a94e0a-91b9-4f83-9fba-601b04d8fe20",

"agentWindows": "b8a94e0a-91b9-4f83-9fba-601b04d8fe20",

"allowedBSSIDGroup": null,

"allowedESSIDGroup": null,

"multihomeDetectionEnabled": false,

"legacyActionsEnabled": true,

"guid": null,

"globalModifiedDate": "2023-11-01T21:53:45.000+0000",

"lastModifiedBy": "SYSTEM",

"lastModifiedDate": "2023-12-04T18:55:15.000+0000",

"id": 1,

"scanName": "OS-Anti-Virus-Check"

}

],

"filtered": 1,

"total": 1

}

Get /policy/endpoint-compliance-configuration

Get /policy/endpoint-compliance-configuration

Description

Returns a list of Endpoint Compliance Configuration records matching 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/policy/endpoint-compliance-configuration

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "success",

"errorMessage": null,

"results": [

{

"name": "Virus Can",

"note": "",

"agents": {

"WINDOWS_CE": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"OPENBSD": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"SOLARIS": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"Mac-OS-X": "b8a94e0a-91b9-4f83-9fba-601b04d8fe20",

"Windows": "b8a94e0a-91b9-4f83-9fba-601b04d8fe20",

"Any": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"APPLE_IOS_IPAD": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"RIM_TABLET_OS": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"CHROME_OS": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"WINDOWS_RT": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"FREEBSD": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"KINDLE": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"APPLE_IOS_IPOD": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"LINUX_OTHER": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"APPLE_IOS": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"WEBOS": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"Linux": "b8a94e0a-91b9-4f83-9fba-601b04d8fe20",

"BLACKBERRY_10": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"LINUX_x86": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"APPLE_IOS_IPHONE": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"NETBSD": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"SYMBIAN": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"ANDROID": "dee7da73-46cd-40b1-8bbf-b39ca0bc1b5e",

"BLACKBERRY_OS": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"WINDOWS_PHONE": "3255ea97-14ad-432a-b2b4-fa4332aba950"

},

"actions": {},

"profileID": 2,

"scriptProfile": {

"lastModifiedBy": "",

"lastModifiedDate": "1970-01-01T00:00:00.000+0000",

"lastChangeSummary": "",

"name": "OS-Anti-Virus-Check",

"guid": -1,

"globalModifiedDate": "1970-01-01T00:00:00.000+0000",

"scriptType": 0,

"entityType": 7,

"groupID": -1,

"id": 2,

"state": 0,

"renewIP": false,

"scanRogue": true,

"registerFailedRogue": false,

"scanOnConnect": false,

"auditOnly": false,

"elapsedNumberOfDays": 0,

"jailbreakThreshold": -1,

"rootThreshold": -1,

"auditObjectName": "OS-Anti-Virus-Check",

"auditObjectType": {

"auditTableName": "SCRIPTPROFILEAudit",

"mysqlTableName": "SCRIPTPROFILE",

"idnameQuery": "select id,name from SCRIPTPROFILE where id in"

},

"modifyAuditSummary": "",

"addAuditSummary": "",

"policyHash": -1997650250,

"timeToWait": 120,

"allAgentUUIDs": []

},

"appCollectionEnabled": false,

"agentAndroid": "dee7da73-46cd-40b1-8bbf-b39ca0bc1b5e",

"agentIOSUnknown": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"agentIOSIPad": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"agentIOSIPhone": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"agentIOSIPod": "3255ea97-14ad-432a-b2b4-fa4332aba950",

"agentLinux": "b8a94e0a-91b9-4f83-9fba-601b04d8fe20",

"agentMacOSX": "b8a94e0a-91b9-4f83-9fba-601b04d8fe20",

"agentWindows": "b8a94e0a-91b9-4f83-9fba-601b04d8fe20",

"allowedBSSIDGroup": null,

"allowedESSIDGroup": null,

"multihomeDetectionEnabled": false,

"legacyActionsEnabled": true,

"guid": null,

"globalModifiedDate": "2023-11-01T21:53:45.000+0000",

"lastModifiedBy": "SYSTEM",

"lastModifiedDate": "2023-12-04T18:55:15.000+0000",

"id": 1,

"scanName": "OS-Anti-Virus-Check"

}

],

"filtered": 1,

"total": 1

}