Fortinet white logo
Fortinet white logo

Rest API

7.4.0

Get /host/client-filters

Get /host/client-filters

Description

Returns all private Client Filters, used for multi-filter queries. If allowed, shared Client Filters are also included.

Request Parameter

Id, the DBID of the host record.

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

serverIP Required String

Sample Request

Request URL

GET https://10.106.94.152:8443/api/v2/host/client-filters

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body

serverIP: xxxxxxxxx

Sample Response

{

"status": "string",

"errorMessage": "string",

"results": [

{

"id": 0,

"filterName": "string",

"isShared": true,

"filterType": "string",

"orFilter": "string",

"adapConnected": "string",

"adapEnabled": "string",

"adapValidMac": "string",

"adapIP": "string",

"adapLocation": "string",

"adapConnectedContainer": "string",

"adapDpcRuleName": "string",

"adapVendorName": "string",

"adapAccessVal": "string",

"adapMediaType": "string",

"adapAuthType": "string",

"adapInnerEapType": "string",

"adapOuterEapType": "string",

"adapDescr": "string",

"adapMac": "string",

"hostID": "string",

"hostConnected": "string",

"hostEnabled": "string",

"hostSecurity": "string",

"hostVulnerabilityScanStatus": "string",

"hostCreatedStart": 0,

"hostCreatedEnd": 0,

"hostCreatedLastX": 0,

"hostExpirationStart": 0,

"hostExpirationEnd": 0,

"hostInactivityStart": 0,

"hostInactivityEnd": 0,

"hostInactivityLastX": 0,

"hostVulnerabilityScanStart": 0,

"hostVulnerabilityScanLastX": 0,

"hostExpirationLastX": 0,

"hostLastContactLastX": 0,

"hostCreatedPeriod": "string",

"hostExpirationPeriod": "string",

"hostInactivityPeriod": "string",

"hostLastContactStart": "string",

"hostLastContactEnd": "string",

"hostLastContactPeriod": "string",

"hostVulnerabilityScanEnd": "string",

"hostVulnerabilityScanPeriod": "string",

"hostAppName": "string",

"hostAppCategory": "string",

"hostHasPAgent": "string",

"hostPACommunicating": "string",

"hostAgentVersion": "string",

"hostAgentPlatform": "string",

"hostRole": "string",

"hostSecurityAccessVal": "string",

"hostHostName": "string",

"hostOwner": "string",

"hostCurrentUser": "string",

"hostVPNClient": "string",

"hostOS": "string",

"hostAgentTag": "string",

"hostAgentID": "string",

"hostOpenPorts": "string",

"hostNotes": "string",

"hostType": "string",

"hostTypeIncIPPhone": "string",

"hostHWType": "string",

"hostSerial": "string",

"hostDevType": "string",

"hostCriticality": "string",

"hostAuth": "string",

"hostMdmManaged": "string",

"hostMdmCompliance": "string",

"hostMdmCompromised": "string",

"hostMdmDataProtect": "string",

"hostMdmPasscode": "string",

"userEnabled": "string",

"userType": "string",

"userRole": "string",

"userSecurityAccessVal": "string",

"userFirstName": "string",

"userLastName": "string",

"userID": "string",

"userTitle": "string",

"userDN": "string",

"userAuth": "string",

"userNotes": "string",

"userAddress": "string",

"userZip": "string",

"userCity": "string",

"userPhone": "string",

"userMailState": "string",

"userEmail": "string",

"userMobileNum": "string",

"userMobileProvider": "string",

"userCreatedEnd": 0,

"userCreatedLastX": 0,

"userCreatedStart": 0,

"userExpirationLastX": 0,

"userInactivityEnd": 0,

"userInactivityLastX": 0,

"userInactivityStart": 0,

"userLastActivityEnd": 0,

"userLastActivityLastX": 0,

"userLastActivityStart": 0,

"userCreatedPeriod": "string",

"userExpirationEnd": "string",

"userExpirationPeriod": "string",

"userExpirationStart": "string",

"userInactivityPeriod": "string",

"userLastActivityPeriod": "string"

}

]

}

Get /host/client-filters

Get /host/client-filters

Description

Returns all private Client Filters, used for multi-filter queries. If allowed, shared Client Filters are also included.

Request Parameter

Id, the DBID of the host record.

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

serverIP Required String

Sample Request

Request URL

GET https://10.106.94.152:8443/api/v2/host/client-filters

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body

serverIP: xxxxxxxxx

Sample Response

{

"status": "string",

"errorMessage": "string",

"results": [

{

"id": 0,

"filterName": "string",

"isShared": true,

"filterType": "string",

"orFilter": "string",

"adapConnected": "string",

"adapEnabled": "string",

"adapValidMac": "string",

"adapIP": "string",

"adapLocation": "string",

"adapConnectedContainer": "string",

"adapDpcRuleName": "string",

"adapVendorName": "string",

"adapAccessVal": "string",

"adapMediaType": "string",

"adapAuthType": "string",

"adapInnerEapType": "string",

"adapOuterEapType": "string",

"adapDescr": "string",

"adapMac": "string",

"hostID": "string",

"hostConnected": "string",

"hostEnabled": "string",

"hostSecurity": "string",

"hostVulnerabilityScanStatus": "string",

"hostCreatedStart": 0,

"hostCreatedEnd": 0,

"hostCreatedLastX": 0,

"hostExpirationStart": 0,

"hostExpirationEnd": 0,

"hostInactivityStart": 0,

"hostInactivityEnd": 0,

"hostInactivityLastX": 0,

"hostVulnerabilityScanStart": 0,

"hostVulnerabilityScanLastX": 0,

"hostExpirationLastX": 0,

"hostLastContactLastX": 0,

"hostCreatedPeriod": "string",

"hostExpirationPeriod": "string",

"hostInactivityPeriod": "string",

"hostLastContactStart": "string",

"hostLastContactEnd": "string",

"hostLastContactPeriod": "string",

"hostVulnerabilityScanEnd": "string",

"hostVulnerabilityScanPeriod": "string",

"hostAppName": "string",

"hostAppCategory": "string",

"hostHasPAgent": "string",

"hostPACommunicating": "string",

"hostAgentVersion": "string",

"hostAgentPlatform": "string",

"hostRole": "string",

"hostSecurityAccessVal": "string",

"hostHostName": "string",

"hostOwner": "string",

"hostCurrentUser": "string",

"hostVPNClient": "string",

"hostOS": "string",

"hostAgentTag": "string",

"hostAgentID": "string",

"hostOpenPorts": "string",

"hostNotes": "string",

"hostType": "string",

"hostTypeIncIPPhone": "string",

"hostHWType": "string",

"hostSerial": "string",

"hostDevType": "string",

"hostCriticality": "string",

"hostAuth": "string",

"hostMdmManaged": "string",

"hostMdmCompliance": "string",

"hostMdmCompromised": "string",

"hostMdmDataProtect": "string",

"hostMdmPasscode": "string",

"userEnabled": "string",

"userType": "string",

"userRole": "string",

"userSecurityAccessVal": "string",

"userFirstName": "string",

"userLastName": "string",

"userID": "string",

"userTitle": "string",

"userDN": "string",

"userAuth": "string",

"userNotes": "string",

"userAddress": "string",

"userZip": "string",

"userCity": "string",

"userPhone": "string",

"userMailState": "string",

"userEmail": "string",

"userMobileNum": "string",

"userMobileProvider": "string",

"userCreatedEnd": 0,

"userCreatedLastX": 0,

"userCreatedStart": 0,

"userExpirationLastX": 0,

"userInactivityEnd": 0,

"userInactivityLastX": 0,

"userInactivityStart": 0,

"userLastActivityEnd": 0,

"userLastActivityLastX": 0,

"userLastActivityStart": 0,

"userCreatedPeriod": "string",

"userExpirationEnd": "string",

"userExpirationPeriod": "string",

"userExpirationStart": "string",

"userInactivityPeriod": "string",

"userLastActivityPeriod": "string"

}

]

}