Update a widget

PUT /widgets/{id}

Update a widget

cURL

curl --request PUT \
  --url https://api.eu.bronto.io/widgets/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-BRONTO-API-KEY: <api-key>' \
  --data '
{
  "name": "5xx errors by service",
  "type": "treemap",
  "description": "This widget shows the 5xx errors by service",
  "aux": {},
  "sources": [
    {
      "type": "metric",
      "id": "7a1c4e2b-0d3f-4a5b-8c6d-9e0f1a2b3c4d"
    },
    {
      "type": "slo",
      "id": "91bd5a3e-2c4f-4d6a-8b0c-2e4f6a8c0d1e"
    }
  ],
  "metric_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "widget_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

400

{
  "code": 400,
  "type": "Bad Request",
  "correlation_id": "95c6a974e3ab01209b6b0dfedb1b16c5",
  "details": "Validation failed: 'name' field is required and cannot be empty"
}

Authorizations

ApiKeyAuthBearerAuth

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"

type · string · required

The widget type

Required string length: 1 - 64

Example:

"treemap"

description · string

The widget description

Required string length: 1 - 1024

Example:

"This widget shows the 5xx errors by service"

aux · object

Additional widget configuration

sources · object[]

The metrics, monitors and SLOs that supply data to the widget, in display order. Used by every widget type except group. Cannot be combined with metric_ids or widget_ids.

Maximum array length: 20

Show child attributes

Example:

[
  {
    "type": "metric",
    "id": "7a1c4e2b-0d3f-4a5b-8c6d-9e0f1a2b3c4d"
  },
  {
    "type": "slo",
    "id": "91bd5a3e-2c4f-4d6a-8b0c-2e4f6a8c0d1e"
  }
]

metric_ids · string<uuid>[] · deprecated

Deprecated on 2026-10-12 and will be removed on 2027-10-12: use sources with type: metric. Requests using this field receive Deprecation and Sunset response headers. Each ID is stored as {type: metric, id}. Cannot be combined with sources or widget_ids.

Maximum array length: 20

widget_ids · string<uuid>[]

The child widget IDs of a group widget. Required for group widgets and must be omitted for all other widget types. Cannot be combined with sources or metric_ids.

Maximum array length: 50

Response

204

Widget successfully updated