Skip to main content
PUT
Update a widget

Authorizations

X-BRONTO-API-KEY
string
header
required

Path Parameters

id
string<uuid>
required

The unique identifier of the widget to update

Body

application/json
name
string
required

The widget name

Required string length: 1 - 255
Example:

"5xx errors by service"

description
string

The widget description

Required string length: 1 - 1024
Example:

"This widget shows the 5xx errors by service"

type
string

The widget type

Required string length: 1 - 64
Example:

"treemap"

aux
object

Additional widget configuration

metric_ids
string<uuid>[]

The metric IDs associated with the widget. A widget can include either metrics or widgets, but not both.

Maximum array length: 20
widget_ids
string<uuid>[]

The widget IDs associated with the widget. A widget can include either metrics or widgets, but not both.

Maximum array length: 50

Response

Widget successfully updated