Fortinet black logo

Utility widget

Utility widget

A validation exists to check for valid widgetId, which are of type "CUST." The following API can be used to acquire a list of all widgets that can be applied to the customer.

List all widgets resource by type

Method

URL

Description

Arguments

Outputs

GET

/customers/{cid}/widgets/?type=<type>

List all widgets resource of type (either SP or CUST depending upon query parameter (SP, default))

type

See the Outputs table.

Arguments

Parameter

Type

Description

type

string

Type of widget Customer “CUST” or Service provider “SP”

Outputs

HTTP Response 200 OK

Response Data:

Parameter

Type

Description

widgetId

int

Widget ID

uid

string

Unique identifier name for widget

name

string

Name of widget

type

string

SP or CUST

Utility widget

A validation exists to check for valid widgetId, which are of type "CUST." The following API can be used to acquire a list of all widgets that can be applied to the customer.

List all widgets resource by type

Method

URL

Description

Arguments

Outputs

GET

/customers/{cid}/widgets/?type=<type>

List all widgets resource of type (either SP or CUST depending upon query parameter (SP, default))

type

See the Outputs table.

Arguments

Parameter

Type

Description

type

string

Type of widget Customer “CUST” or Service provider “SP”

Outputs

HTTP Response 200 OK

Response Data:

Parameter

Type

Description

widgetId

int

Widget ID

uid

string

Unique identifier name for widget

name

string

Name of widget

type

string

SP or CUST