Skip to main content
PUT
PUT /v1/services/dashboardServices

Update a Dashboard Service

Create a dashboard service or update it if it already exists, using PUT /v1/services/dashboardServices with the full request body. Send the complete definition, not just the fields you want to change. To change only some fields, use PATCH with a JSON Patch array and the application/json-patch+json content type, as shown in the PATCH examples below.

Body Parameters

string
required
Name of the dashboard service. Must be unique across all dashboard services.
string
required
Type of dashboard service, for example Superset, Looker, Tableau, Metabase, Redash, PowerBI, Mode, QlikSense, QlikCloud, Lightdash, DomoDashboard, CustomDashboard.
string
Description of the dashboard service in Markdown format.
string
Human-readable display name for the dashboard service.
object
Connection configuration specific to the service type.
array
Array of owner references (users or teams) to assign to the service.
array
Fully qualified names of the domains to assign for governance purposes.
array
Array of classification tags to apply to the dashboard service.
PUT /v1/services/dashboardServices

Returns

Returns the updated dashboard service object with the new version number.

Response

string
Unique identifier for the dashboard service (UUID format).
string
Dashboard service name.
string
Fully qualified name of the service.
string
Updated description.
number
Incremented version number.

Error Handling