Fortinet white logo
Fortinet white logo

Rest API

7.2.0

Get /settings/agent/properties

Get /settings/agent/properties

Description

Returns a list of security management properties for the Persistent Agent.

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

Get https://10.106.94.152:8443/api/v2/settings/agent/properties

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "string",

"errorMessage": "string",

"result": {

"vmDetection": "string",

"onConnectHostGroup": "string",

"requireConnectedAdapter": {

"enabled": "string",

"ipv4Ranges": [

"string"

],

"ipv6Ranges": [

"string"

]

},

"expirationEnabled": "string",

"expirationTime": "string",

"networkChangeMsg": "string",

"invalidOUIMsg": "string",

"failedReg": "string",

"failedScan": "string",

"warnMsg": "string",

"successReg": "string",

"reAuthPrompt": "string",

"loginPrompt": "string",

"userNameLabel": "string",

"passwordLabel": "string",

"displayNotifications": "string",

"secondaryHostName": "string",

"hostConnectGracePeriod": "string",

"agentDisconnectGracePeriod": "string",

"hostDisconnectGracePeriod": "string",

"connectExternalHostsGroup": "string",

"header": "string",

"footer": "string",

"cacheStrategy": "string",

"cacheStrategyPollInterval": "string",

"cacheStrategyExpireTime": "string",

"remediationMsg": "string",

"paConfigForHA": "string",

"showExpiration": "string",

"hostName": "string",

"hostGroups": [

{

"name": "string",

"nameLabel": "string",

"id": "string"

}

]

}

}

Get /settings/agent/properties

Get /settings/agent/properties

Description

Returns a list of security management properties for the Persistent Agent.

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

Get https://10.106.94.152:8443/api/v2/settings/agent/properties

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "string",

"errorMessage": "string",

"result": {

"vmDetection": "string",

"onConnectHostGroup": "string",

"requireConnectedAdapter": {

"enabled": "string",

"ipv4Ranges": [

"string"

],

"ipv6Ranges": [

"string"

]

},

"expirationEnabled": "string",

"expirationTime": "string",

"networkChangeMsg": "string",

"invalidOUIMsg": "string",

"failedReg": "string",

"failedScan": "string",

"warnMsg": "string",

"successReg": "string",

"reAuthPrompt": "string",

"loginPrompt": "string",

"userNameLabel": "string",

"passwordLabel": "string",

"displayNotifications": "string",

"secondaryHostName": "string",

"hostConnectGracePeriod": "string",

"agentDisconnectGracePeriod": "string",

"hostDisconnectGracePeriod": "string",

"connectExternalHostsGroup": "string",

"header": "string",

"footer": "string",

"cacheStrategy": "string",

"cacheStrategyPollInterval": "string",

"cacheStrategyExpireTime": "string",

"remediationMsg": "string",

"paConfigForHA": "string",

"showExpiration": "string",

"hostName": "string",

"hostGroups": [

{

"name": "string",

"nameLabel": "string",

"id": "string"

}

]

}

}