Fortinet white logo
Fortinet white logo

Rest API

7.4.0

Get /device/port/{id}

Get /device/port/{id}

Description

Returns the Port record that matches the provided id.

Request Parameter

Id, the Id of the Port 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

Sample Request

Request URL

Get https://10.106.94.152:8443/api/v2/device/port/3

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "string",

"errorMessage": "string",

"results": [

{

"dbid": 0,

"legacyDBID": 0,

"portType": 0,

"name": "string",

"portID": "string",

"displayName": "string",

"deviceName": "string",

"deviceID": 0,

"status": 0,

"domainID": 0,

"ip": "string",

"physAddr": "string",

"label": "string",

"connectionState": 0,

"defaultVlan": "string",

"currentVlan": "string",

"currentCli": "string",

"notes": "string",

"lastModifiedBy": "string",

"lastChangeSummary": "string",

"lastModifiedDate": "2023-12-29T00:06:25.713Z",

"displayable": true,

"ifname": "string",

"ifindex": "string",

"ifspeed": "string",

"ifdescr": "string",

"ifadminStatus": 0,

"ifoperStatus": 0,

"yamsEventTag": "string",

"auditObj": {

"user": "string",

"action": "string",

"timestamp": "2023-12-29T00:06:25.713Z",

"liveObj": {

"yamsEventTag": "string",

"auditObj": "string"

},

"auditDBID": 0,

"liveDBID": 0,

"yamsEventTag": "string",

"auditObj": "string"

},

"uplinkDisabled": true

}

],

"filtered": 0,

"total": 0

}

Get /device/port/{id}

Get /device/port/{id}

Description

Returns the Port record that matches the provided id.

Request Parameter

Id, the Id of the Port 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

Sample Request

Request URL

Get https://10.106.94.152:8443/api/v2/device/port/3

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "string",

"errorMessage": "string",

"results": [

{

"dbid": 0,

"legacyDBID": 0,

"portType": 0,

"name": "string",

"portID": "string",

"displayName": "string",

"deviceName": "string",

"deviceID": 0,

"status": 0,

"domainID": 0,

"ip": "string",

"physAddr": "string",

"label": "string",

"connectionState": 0,

"defaultVlan": "string",

"currentVlan": "string",

"currentCli": "string",

"notes": "string",

"lastModifiedBy": "string",

"lastChangeSummary": "string",

"lastModifiedDate": "2023-12-29T00:06:25.713Z",

"displayable": true,

"ifname": "string",

"ifindex": "string",

"ifspeed": "string",

"ifdescr": "string",

"ifadminStatus": 0,

"ifoperStatus": 0,

"yamsEventTag": "string",

"auditObj": {

"user": "string",

"action": "string",

"timestamp": "2023-12-29T00:06:25.713Z",

"liveObj": {

"yamsEventTag": "string",

"auditObj": "string"

},

"auditDBID": 0,

"liveDBID": 0,

"yamsEventTag": "string",

"auditObj": "string"

},

"uplinkDisabled": true

}

],

"filtered": 0,

"total": 0

}