Fortinet Document Library

Version:

Version:

Version:


Table of Contents

REST API Solution Guide

Download PDF
Copy Link

Fabric widget detail by visualization type (/fabric/widget/id)

URL:  https://[server_name]/api/v1/fabric/widget/(id)?visualization_type=(type)

This endpoint is used to retrieve individual widget data for FortiOS to display. Widgets are obtained by their string ID, and the visualization type is a query parameter. It requires a valid Bearer token in the Authorization header.

Supported fields

Field Display name Type Required
id The string identifier of the widget string Yes
type The string identifier for the visualization type string Yes

Allowed methods

HTTP method Resource URI Action
GET /api/v1/fabric/widget/(id)?visualization_type=(type) Get a list of available widgets and the visualization types that they support.

Response codes

In addition to the general codes defined in General API response codes, a POST request to this resource can also result in the following return codes:

Code Response content Description
200 OK Widget detail information  
401 Unauthorized   Invalid Bearer token

Example

Get Widget Detail Info:

curl -k -v -X GET \

https://[FortiAuthenticator_IP]/api/v1/fabric/widget/sysinfo?visualization_type=key-value-pair \

-H 'Authorization: Bearer shrWNdu1xJRUgpcUi2bhYRX1Sl8pXe'

 

Response:

{

"data": [

{

"lang_key": "hostname",

"value": "FortiAuthenticator"

},

...

],

"meta": {

"language": {

"en": {

"devicefqdn": "Device FQDN",

...

}

},

"polling": false,

"polling_interval_min": 0,

"visualization_type": "key-value-pair"

}

}

Fabric widget detail by visualization type (/fabric/widget/id)

URL:  https://[server_name]/api/v1/fabric/widget/(id)?visualization_type=(type)

This endpoint is used to retrieve individual widget data for FortiOS to display. Widgets are obtained by their string ID, and the visualization type is a query parameter. It requires a valid Bearer token in the Authorization header.

Supported fields

Field Display name Type Required
id The string identifier of the widget string Yes
type The string identifier for the visualization type string Yes

Allowed methods

HTTP method Resource URI Action
GET /api/v1/fabric/widget/(id)?visualization_type=(type) Get a list of available widgets and the visualization types that they support.

Response codes

In addition to the general codes defined in General API response codes, a POST request to this resource can also result in the following return codes:

Code Response content Description
200 OK Widget detail information  
401 Unauthorized   Invalid Bearer token

Example

Get Widget Detail Info:

curl -k -v -X GET \

https://[FortiAuthenticator_IP]/api/v1/fabric/widget/sysinfo?visualization_type=key-value-pair \

-H 'Authorization: Bearer shrWNdu1xJRUgpcUi2bhYRX1Sl8pXe'

 

Response:

{

"data": [

{

"lang_key": "hostname",

"value": "FortiAuthenticator"

},

...

],

"meta": {

"language": {

"en": {

"devicefqdn": "Device FQDN",

...

}

},

"polling": false,

"polling_interval_min": 0,

"visualization_type": "key-value-pair"

}

}