Documentation by ClonePartner

Start typing to search.

API Reference

Save an input widget's config value

View Markdown
PUT /api/dashboards/{id}/widgets/{widgetId}/config

Validates the value against the widget schema (and optional validation_expr), applies any transform_expr, then upserts it under the widget's config_key. Only config_keys declared by an input widget in this dashboard are writable. Open to any authenticated user.

Operation IDsaveDashboardWidgetConfig

Authentication

  • BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

idintegerrequired

Resource ID

widgetIdstringrequired

Request body

This request body is required.

Content typeapplication/json

requestobject
1 property
valueunknownrequired

Persisted value for the widget. field_mapping → array of { source_field, target_field, transform? }; form → object keyed by field key.

Success response body

200Saved

Saved

Content typeapplication/json

responseobject
1 property
okboolean

Error responses

400Validation error

Validation error

Content typeapplication/json

responseobject
2 properties
errorstring
Example
NOT_FOUND
messagestring
Example
Resource not found
Example response
{
  "error": "VALIDATION_ERROR",
  "message": "Invalid input"
}

404Resource not found

Resource not found

Content typeapplication/json

responseobject
2 properties
errorstring
Example
NOT_FOUND
messagestring
Example
Resource not found
Example response
{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}