Fortinet white logo
Fortinet white logo

Rest API

7.4.0

Get /host/ncm-pods

Get /host/ncm-pods

Description

Return all Host Records, with User and Adapter information, which match the supplied multifilter string.

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/host/ncm-pods

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "string",

"errorMessage": "string",

"results": [

{

"element": {

"landscape": 0,

"id": 0,

"state": "string",

"elementClass": "string",

"role": "string",

"name": "string",

"type": "string",

"protocol": "string",

"status": "string",

"parent": "string",

"suffix": "string",

"version": 0,

"notes": "string",

"description": {},

"group": "string",

"pollingInterval": 0,

"lastPoll": "2024-03-01T00:09:39.054Z",

"lastSuccessfulPoll": "2024-03-01T00:09:39.054Z",

"mibs": [

"string"

],

"requestString": "string",

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"addAuditSummary": "string",

"physicalAddress": "string",

"domainName": "string",

"identification": "string",

"creationEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-01T00:09:39.054Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"destroyEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-01T00:09:39.054Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"establishedEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-01T00:09:39.054Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"lostEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-01T00:09:39.054Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"packedVersion": 0,

"changeMask": 0,

"sysOid": "string",

"longSuffix": 0,

"attribute": [

{

"version": 0,

"attributeName": "string",

"attribute": "string",

"table": true,

"discoverObject": true,

"mandatory": true,

"value": "string",

"group": "string",

"type": "string",

"access": "string",

"error": "string",

"objectValue": {},

"attributeSuffix": "string"

}

],

"attributeNames": [

"string"

],

"lastChangeMask": 0

},

"domains": {

"additionalProp1": "string",

"additionalProp2": "string",

"additionalProp3": "string"

},

"port": "string",

"ip": "string",

"name": "string"

}

]

}

Get /host/ncm-pods

Get /host/ncm-pods

Description

Return all Host Records, with User and Adapter information, which match the supplied multifilter string.

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/host/ncm-pods

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "string",

"errorMessage": "string",

"results": [

{

"element": {

"landscape": 0,

"id": 0,

"state": "string",

"elementClass": "string",

"role": "string",

"name": "string",

"type": "string",

"protocol": "string",

"status": "string",

"parent": "string",

"suffix": "string",

"version": 0,

"notes": "string",

"description": {},

"group": "string",

"pollingInterval": 0,

"lastPoll": "2024-03-01T00:09:39.054Z",

"lastSuccessfulPoll": "2024-03-01T00:09:39.054Z",

"mibs": [

"string"

],

"requestString": "string",

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"addAuditSummary": "string",

"physicalAddress": "string",

"domainName": "string",

"identification": "string",

"creationEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-01T00:09:39.054Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"destroyEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-01T00:09:39.054Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"establishedEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-01T00:09:39.054Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"lostEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-01T00:09:39.054Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"packedVersion": 0,

"changeMask": 0,

"sysOid": "string",

"longSuffix": 0,

"attribute": [

{

"version": 0,

"attributeName": "string",

"attribute": "string",

"table": true,

"discoverObject": true,

"mandatory": true,

"value": "string",

"group": "string",

"type": "string",

"access": "string",

"error": "string",

"objectValue": {},

"attributeSuffix": "string"

}

],

"attributeNames": [

"string"

],

"lastChangeMask": 0

},

"domains": {

"additionalProp1": "string",

"additionalProp2": "string",

"additionalProp3": "string"

},

"port": "string",

"ip": "string",

"name": "string"

}

]

}