Fortinet white logo
Fortinet white logo

Rest API

7.4.0

Get /settings/integration/messaging-gateway

Get /settings/integration/messaging-gateway

Description

Returns a list of Message Gateway records matching the supplied filter.

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

filter Optional Array
start Optional Integer
count Optional Integer
sortKey Optional String
sortDir Optional String

Sample Request

Request URL

GET https://10.106.94.152:8443/api/v2/settings/integration/messaging-gateway

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "success",

"errorMessage": null,

"results": [

{

"dbid": 1,

"name": "3 River Wireless",

"protocol": "SMTP",

"gatewayAddress": "xxxxxxxxxx@sms.3rivers.net",

"country": "United States",

"maxMessageLength": -1,

"prefix": null,

"suffix": null,

"yamsEventTag": null,

"auditObj": null,

"enabled": false

}

],

"filtered": 1,

"total": 1

}

Get /settings/integration/messaging-gateway

Get /settings/integration/messaging-gateway

Description

Returns a list of Message Gateway records matching the supplied filter.

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

filter Optional Array
start Optional Integer
count Optional Integer
sortKey Optional String
sortDir Optional String

Sample Request

Request URL

GET https://10.106.94.152:8443/api/v2/settings/integration/messaging-gateway

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "success",

"errorMessage": null,

"results": [

{

"dbid": 1,

"name": "3 River Wireless",

"protocol": "SMTP",

"gatewayAddress": "xxxxxxxxxx@sms.3rivers.net",

"country": "United States",

"maxMessageLength": -1,

"prefix": null,

"suffix": null,

"yamsEventTag": null,

"auditObj": null,

"enabled": false

}

],

"filtered": 1,

"total": 1

}