Fortinet white logo
Fortinet white logo

Rest API

7.4.0

Post /policy/endpoint-compliance-configuration/{id}

Post /policy/endpoint-compliance-configuration/{id}

Description

Updates an Endpoint Compliance Configuration record

Request Parameter

Id, the Endpoint Compliance Configuration record Id.

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

Sample Request

Request URL

POST https://10.106.94.152:8443/api/v2/policy/endpoint-compliance-configuration/1

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body

{

"name": "string",

"note": "string",

"agents": {

"additionalProp1": "string",

"additionalProp2": "string",

"additionalProp3": "string"

},

"actions": {

"additionalProp1": 0,

"additionalProp2": 0,

"additionalProp3": 0

},

"profileID": 0,

"scriptProfile": {

"lastModifiedBy": "string",

"lastModifiedDate": "2024-03-07T23:29:27.568Z",

"lastChangeSummary": "string",

"name": "string",

"guid": 0,

"globalModifiedDate": "2024-03-07T23:29:27.568Z",

"scriptType": "string",

"entityType": "string",

"groupID": 0,

"linkUp": true,

"patchURL": "string",

"id": 0,

"state": "string",

"portGroupName": "string",

"deviceGroupName": "string",

"patchInformation": "string",

"defaultPolicy": true,

"registrationPolicy": true,

"remediationPolicy": true,

"agentPolicy": true,

"vpnPolicy": true,

"renewIP": true,

"scanRogue": true,

"registerFailedRogue": true,

"groupName": "string",

"bypassedOperatingSystems": [

{}

],

"persistenAgentRequired": [

{}

],

"scanOnConnect": true,

"label": "string",

"auditOnly": true,

"elapsedNumberOfDays": 0,

"jailbreakThreshold": 0,

"rootThreshold": 0,

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"modifyAuditSummary": "string",

"addAuditSummary": "string",

"directoryAttrVal": "string",

"policyHash": 0,

"timeToWait": 0,

"securityElement": 0,

"allAgentUUIDs": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

],

"epcmodifyAuditSummary": true,

"otherModifyAuditSummary": true

},

"appCollectionEnabled": true,

"agentAndroid": "string",

"agentIOSUnknown": "string",

"agentIOSIPad": "string",

"agentIOSIPhone": "string",

"agentIOSIPod": "string",

"agentLinux": "string",

"agentMacOSX": "string",

"agentWindows": "string",

"allowedBSSIDGroup": {

"landscape": 0,

"dbid": 0,

"elementClass": 0,

"name": "string",

"userGroup": true,

"description": "string",

"accessPolicy": 0,

"daysValid": 0,

"daysInactive": 0,

"guid": 0,

"globalModifiedDate": "2024-03-07T23:29:27.568Z",

"nameLabel": "string"

},

"allowedESSIDGroup": {

"landscape": 0,

"dbid": 0,

"elementClass": 0,

"name": "string",

"userGroup": true,

"description": "string",

"accessPolicy": 0,

"daysValid": 0,

"daysInactive": 0,

"guid": 0,

"globalModifiedDate": "2024-03-07T23:29:27.568Z",

"nameLabel": "string"

},

"multihomeDetectionEnabled": true,

"legacyActionsEnabled": true,

"guid": 0,

"globalModifiedDate": "2024-03-07T23:29:27.568Z",

"auditObj": {

"auditDBID": 0,

"liveDBID": 0,

"liveObj": {

"auditObj": "string",

"yamsEventTag": "string"

},

"user": "string",

"action": "string",

"timestamp": "2024-03-07T23:29:27.568Z",

"auditObj": "string",

"yamsEventTag": "string"

},

"yamsEventTag": "string",

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"scanName": "string",

"agentSettings": {

"additionalProp1": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"additionalProp2": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"additionalProp3": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

},

"eventActions": {

"additionalProp1": {

"dbid": 0,

"name": "string",

"guid": 0,

"globalModifiedDate": "2024-03-07T23:29:27.568Z",

"onFailure": "string",

"secondaryActionTimer": 0,

"activities": [

{

"dbid": 0,

"rank": 0,

"version": 0,

"type": "string",

"attributes": {

"additionalProp1": "string",

"additionalProp2": "string",

"additionalProp3": "string"

},

"auditObj": {

"auditDBID": 0,

"liveDBID": 0,

"liveObj": {

"auditObj": "string",

"yamsEventTag": "string"

},

"user": "string",

"action": "string",

"timestamp": "2024-03-07T23:29:27.568Z",

"auditObj": "string",

"yamsEventTag": "string"

},

"yamsEventTag": "string",

"typeDescription": "string",

"auditString": "string"

}

],

"auditObj": {

"auditDBID": 0,

"liveDBID": 0,

"liveObj": {

"auditObj": "string",

"yamsEventTag": "string"

},

"user": "string",

"action": "string",

"timestamp": "2024-03-07T23:29:27.568Z",

"auditObj": "string",

"yamsEventTag": "string"

},

"yamsEventTag": "string",

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

}

},

"additionalProp2": {

"dbid": 0,

"name": "string",

"guid": 0,

"globalModifiedDate": "2024-03-07T23:29:27.568Z",

"onFailure": "string",

"secondaryActionTimer": 0,

"activities": [

{

"dbid": 0,

"rank": 0,

"version": 0,

"type": "string",

"attributes": {

"additionalProp1": "string",

"additionalProp2": "string",

"additionalProp3": "string"

},

"auditObj": {

"auditDBID": 0,

"liveDBID": 0,

"liveObj": {

"auditObj": "string",

"yamsEventTag": "string"

},

"user": "string",

"action": "string",

"timestamp": "2024-03-07T23:29:27.568Z",

"auditObj": "string",

"yamsEventTag": "string"

},

"yamsEventTag": "string",

"typeDescription": "string",

"auditString": "string"

}

],

"auditObj": {

"auditDBID": 0,

"liveDBID": 0,

"liveObj": {

"auditObj": "string",

"yamsEventTag": "string"

},

"user": "string",

"action": "string",

"timestamp": "2024-03-07T23:29:27.568Z",

"auditObj": "string",

"yamsEventTag": "string"

},

"yamsEventTag": "string",

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

}

},

"additionalProp3": {

"dbid": 0,

"name": "string",

"guid": 0,

"globalModifiedDate": "2024-03-07T23:29:27.568Z",

"onFailure": "string",

"secondaryActionTimer": 0,

"activities": [

{

"dbid": 0,

"rank": 0,

"version": 0,

"type": "string",

"attributes": {

"additionalProp1": "string",

"additionalProp2": "string",

"additionalProp3": "string"

},

"auditObj": {

"auditDBID": 0,

"liveDBID": 0,

"liveObj": {

"auditObj": "string",

"yamsEventTag": "string"

},

"user": "string",

"action": "string",

"timestamp": "2024-03-07T23:29:27.568Z",

"auditObj": "string",

"yamsEventTag": "string"

},

"yamsEventTag": "string",

"typeDescription": "string",

"auditString": "string"

}

],

"auditObj": {

"auditDBID": 0,

"liveDBID": 0,

"liveObj": {

"auditObj": "string",

"yamsEventTag": "string"

},

"user": "string",

"action": "string",

"timestamp": "2024-03-07T23:29:27.568Z",

"auditObj": "string",

"yamsEventTag": "string"

},

"yamsEventTag": "string",

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

}

}

},

"eventActionIDs": {

"additionalProp1": 0,

"additionalProp2": 0,

"additionalProp3": 0

},

"profile": {

"lastModifiedBy": "string",

"lastModifiedDate": "2024-03-07T23:29:27.568Z",

"lastChangeSummary": "string",

"name": "string",

"guid": 0,

"globalModifiedDate": "2024-03-07T23:29:27.568Z",

"scriptType": "string",

"entityType": "string",

"groupID": 0,

"linkUp": true,

"patchURL": "string",

"id": 0,

"state": "string",

"portGroupName": "string",

"deviceGroupName": "string",

"patchInformation": "string",

"defaultPolicy": true,

"registrationPolicy": true,

"remediationPolicy": true,

"agentPolicy": true,

"vpnPolicy": true,

"renewIP": true,

"scanRogue": true,

"registerFailedRogue": true,

"groupName": "string",

"bypassedOperatingSystems": [

{}

],

"persistenAgentRequired": [

{}

],

"scanOnConnect": true,

"label": "string",

"auditOnly": true,

"elapsedNumberOfDays": 0,

"jailbreakThreshold": 0,

"rootThreshold": 0,

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"modifyAuditSummary": "string",

"addAuditSummary": "string",

"directoryAttrVal": "string",

"policyHash": 0,

"timeToWait": 0,

"securityElement": 0,

"allAgentUUIDs": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

],

"epcmodifyAuditSummary": true,

"otherModifyAuditSummary": true

},

"id": 0

}

Sample Response

{

"status": "success",

"errorMessage": null,

"results": 0

}

Post /policy/endpoint-compliance-configuration/{id}

Post /policy/endpoint-compliance-configuration/{id}

Description

Updates an Endpoint Compliance Configuration record

Request Parameter

Id, the Endpoint Compliance Configuration record Id.

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

Sample Request

Request URL

POST https://10.106.94.152:8443/api/v2/policy/endpoint-compliance-configuration/1

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body

{

"name": "string",

"note": "string",

"agents": {

"additionalProp1": "string",

"additionalProp2": "string",

"additionalProp3": "string"

},

"actions": {

"additionalProp1": 0,

"additionalProp2": 0,

"additionalProp3": 0

},

"profileID": 0,

"scriptProfile": {

"lastModifiedBy": "string",

"lastModifiedDate": "2024-03-07T23:29:27.568Z",

"lastChangeSummary": "string",

"name": "string",

"guid": 0,

"globalModifiedDate": "2024-03-07T23:29:27.568Z",

"scriptType": "string",

"entityType": "string",

"groupID": 0,

"linkUp": true,

"patchURL": "string",

"id": 0,

"state": "string",

"portGroupName": "string",

"deviceGroupName": "string",

"patchInformation": "string",

"defaultPolicy": true,

"registrationPolicy": true,

"remediationPolicy": true,

"agentPolicy": true,

"vpnPolicy": true,

"renewIP": true,

"scanRogue": true,

"registerFailedRogue": true,

"groupName": "string",

"bypassedOperatingSystems": [

{}

],

"persistenAgentRequired": [

{}

],

"scanOnConnect": true,

"label": "string",

"auditOnly": true,

"elapsedNumberOfDays": 0,

"jailbreakThreshold": 0,

"rootThreshold": 0,

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"modifyAuditSummary": "string",

"addAuditSummary": "string",

"directoryAttrVal": "string",

"policyHash": 0,

"timeToWait": 0,

"securityElement": 0,

"allAgentUUIDs": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

],

"epcmodifyAuditSummary": true,

"otherModifyAuditSummary": true

},

"appCollectionEnabled": true,

"agentAndroid": "string",

"agentIOSUnknown": "string",

"agentIOSIPad": "string",

"agentIOSIPhone": "string",

"agentIOSIPod": "string",

"agentLinux": "string",

"agentMacOSX": "string",

"agentWindows": "string",

"allowedBSSIDGroup": {

"landscape": 0,

"dbid": 0,

"elementClass": 0,

"name": "string",

"userGroup": true,

"description": "string",

"accessPolicy": 0,

"daysValid": 0,

"daysInactive": 0,

"guid": 0,

"globalModifiedDate": "2024-03-07T23:29:27.568Z",

"nameLabel": "string"

},

"allowedESSIDGroup": {

"landscape": 0,

"dbid": 0,

"elementClass": 0,

"name": "string",

"userGroup": true,

"description": "string",

"accessPolicy": 0,

"daysValid": 0,

"daysInactive": 0,

"guid": 0,

"globalModifiedDate": "2024-03-07T23:29:27.568Z",

"nameLabel": "string"

},

"multihomeDetectionEnabled": true,

"legacyActionsEnabled": true,

"guid": 0,

"globalModifiedDate": "2024-03-07T23:29:27.568Z",

"auditObj": {

"auditDBID": 0,

"liveDBID": 0,

"liveObj": {

"auditObj": "string",

"yamsEventTag": "string"

},

"user": "string",

"action": "string",

"timestamp": "2024-03-07T23:29:27.568Z",

"auditObj": "string",

"yamsEventTag": "string"

},

"yamsEventTag": "string",

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"scanName": "string",

"agentSettings": {

"additionalProp1": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"additionalProp2": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"additionalProp3": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

},

"eventActions": {

"additionalProp1": {

"dbid": 0,

"name": "string",

"guid": 0,

"globalModifiedDate": "2024-03-07T23:29:27.568Z",

"onFailure": "string",

"secondaryActionTimer": 0,

"activities": [

{

"dbid": 0,

"rank": 0,

"version": 0,

"type": "string",

"attributes": {

"additionalProp1": "string",

"additionalProp2": "string",

"additionalProp3": "string"

},

"auditObj": {

"auditDBID": 0,

"liveDBID": 0,

"liveObj": {

"auditObj": "string",

"yamsEventTag": "string"

},

"user": "string",

"action": "string",

"timestamp": "2024-03-07T23:29:27.568Z",

"auditObj": "string",

"yamsEventTag": "string"

},

"yamsEventTag": "string",

"typeDescription": "string",

"auditString": "string"

}

],

"auditObj": {

"auditDBID": 0,

"liveDBID": 0,

"liveObj": {

"auditObj": "string",

"yamsEventTag": "string"

},

"user": "string",

"action": "string",

"timestamp": "2024-03-07T23:29:27.568Z",

"auditObj": "string",

"yamsEventTag": "string"

},

"yamsEventTag": "string",

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

}

},

"additionalProp2": {

"dbid": 0,

"name": "string",

"guid": 0,

"globalModifiedDate": "2024-03-07T23:29:27.568Z",

"onFailure": "string",

"secondaryActionTimer": 0,

"activities": [

{

"dbid": 0,

"rank": 0,

"version": 0,

"type": "string",

"attributes": {

"additionalProp1": "string",

"additionalProp2": "string",

"additionalProp3": "string"

},

"auditObj": {

"auditDBID": 0,

"liveDBID": 0,

"liveObj": {

"auditObj": "string",

"yamsEventTag": "string"

},

"user": "string",

"action": "string",

"timestamp": "2024-03-07T23:29:27.568Z",

"auditObj": "string",

"yamsEventTag": "string"

},

"yamsEventTag": "string",

"typeDescription": "string",

"auditString": "string"

}

],

"auditObj": {

"auditDBID": 0,

"liveDBID": 0,

"liveObj": {

"auditObj": "string",

"yamsEventTag": "string"

},

"user": "string",

"action": "string",

"timestamp": "2024-03-07T23:29:27.568Z",

"auditObj": "string",

"yamsEventTag": "string"

},

"yamsEventTag": "string",

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

}

},

"additionalProp3": {

"dbid": 0,

"name": "string",

"guid": 0,

"globalModifiedDate": "2024-03-07T23:29:27.568Z",

"onFailure": "string",

"secondaryActionTimer": 0,

"activities": [

{

"dbid": 0,

"rank": 0,

"version": 0,

"type": "string",

"attributes": {

"additionalProp1": "string",

"additionalProp2": "string",

"additionalProp3": "string"

},

"auditObj": {

"auditDBID": 0,

"liveDBID": 0,

"liveObj": {

"auditObj": "string",

"yamsEventTag": "string"

},

"user": "string",

"action": "string",

"timestamp": "2024-03-07T23:29:27.568Z",

"auditObj": "string",

"yamsEventTag": "string"

},

"yamsEventTag": "string",

"typeDescription": "string",

"auditString": "string"

}

],

"auditObj": {

"auditDBID": 0,

"liveDBID": 0,

"liveObj": {

"auditObj": "string",

"yamsEventTag": "string"

},

"user": "string",

"action": "string",

"timestamp": "2024-03-07T23:29:27.568Z",

"auditObj": "string",

"yamsEventTag": "string"

},

"yamsEventTag": "string",

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

}

}

},

"eventActionIDs": {

"additionalProp1": 0,

"additionalProp2": 0,

"additionalProp3": 0

},

"profile": {

"lastModifiedBy": "string",

"lastModifiedDate": "2024-03-07T23:29:27.568Z",

"lastChangeSummary": "string",

"name": "string",

"guid": 0,

"globalModifiedDate": "2024-03-07T23:29:27.568Z",

"scriptType": "string",

"entityType": "string",

"groupID": 0,

"linkUp": true,

"patchURL": "string",

"id": 0,

"state": "string",

"portGroupName": "string",

"deviceGroupName": "string",

"patchInformation": "string",

"defaultPolicy": true,

"registrationPolicy": true,

"remediationPolicy": true,

"agentPolicy": true,

"vpnPolicy": true,

"renewIP": true,

"scanRogue": true,

"registerFailedRogue": true,

"groupName": "string",

"bypassedOperatingSystems": [

{}

],

"persistenAgentRequired": [

{}

],

"scanOnConnect": true,

"label": "string",

"auditOnly": true,

"elapsedNumberOfDays": 0,

"jailbreakThreshold": 0,

"rootThreshold": 0,

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"modifyAuditSummary": "string",

"addAuditSummary": "string",

"directoryAttrVal": "string",

"policyHash": 0,

"timeToWait": 0,

"securityElement": 0,

"allAgentUUIDs": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

],

"epcmodifyAuditSummary": true,

"otherModifyAuditSummary": true

},

"id": 0

}

Sample Response

{

"status": "success",

"errorMessage": null,

"results": 0

}