Skip to main content
PATCH
/
v1
/
dashboards
/
{id}
PATCH /v1/dashboards/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Dashboards

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
dashboard = Dashboards.retrieve("03fb5cc3-de48-423f-9926-8e192e5de59d")
dashboard.description = "Updated: deck.gl Demo dashboard with new visualizations"
dashboard.displayName = "deck.gl Demo v2"
updated = Dashboards.update(dashboard)

print(f"Updated to version {updated.version}")

{
  "id": "03fb5cc3-de48-423f-9926-8e192e5de59d",
  "name": "10",
  "displayName": "deck.gl Demo v2",
  "fullyQualifiedName": "sample_superset.10",
  "description": "Updated: deck.gl Demo dashboard with new visualizations",
  "version": 0.2,
  "updatedAt": 1769982666437,
  "updatedBy": "admin",
  "sourceUrl": "http://localhost:808/superset/dashboard/10/",
  "service": {
    "id": "b1e6a71d-7f47-4e5f-8ce0-e6e8a88ec97a",
    "type": "dashboardService",
    "name": "sample_superset",
    "fullyQualifiedName": "sample_superset",
    "deleted": false
  },
  "serviceType": "Superset",
  "href": "http://localhost:8585/api/v1/dashboards/03fb5cc3-de48-423f-9926-8e192e5de59d",
  "deleted": false,
  "owners": [],
  "tags": [],
  "domains": []
}

​
Update a Dashboard

Update a dashboard’s properties using JSON Merge Patch. You can update by ID or by fully qualified name.

​
Update by ID

​
id
string
required
UUID of the dashboard to update.

​
Update by Name

Use PATCH /v1/dashboards/name/{fqn} to update by fully qualified name.
​
fqn
string
required
Fully qualified name of the dashboard (e.g., sample_superset.10).

​
Body Parameters

Send a JSON object with the fields to update. Only provided fields are changed.
​
description
string
Updated description in Markdown format.
​
displayName
string
Updated display name.
​
sourceUrl
string
Updated source URL.
​
charts
array
Updated list of chart references.
​
owners
array
Updated list of owner references.
​
tags
array
Updated classification tags.
​
domain
string
Updated domain FQN.
​
extension
object
Updated custom property values.
PATCH /v1/dashboards/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Dashboards

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
dashboard = Dashboards.retrieve("03fb5cc3-de48-423f-9926-8e192e5de59d")
dashboard.description = "Updated: deck.gl Demo dashboard with new visualizations"
dashboard.displayName = "deck.gl Demo v2"
updated = Dashboards.update(dashboard)

print(f"Updated to version {updated.version}")

{
  "id": "03fb5cc3-de48-423f-9926-8e192e5de59d",
  "name": "10",
  "displayName": "deck.gl Demo v2",
  "fullyQualifiedName": "sample_superset.10",
  "description": "Updated: deck.gl Demo dashboard with new visualizations",
  "version": 0.2,
  "updatedAt": 1769982666437,
  "updatedBy": "admin",
  "sourceUrl": "http://localhost:808/superset/dashboard/10/",
  "service": {
    "id": "b1e6a71d-7f47-4e5f-8ce0-e6e8a88ec97a",
    "type": "dashboardService",
    "name": "sample_superset",
    "fullyQualifiedName": "sample_superset",
    "deleted": false
  },
  "serviceType": "Superset",
  "href": "http://localhost:8585/api/v1/dashboards/03fb5cc3-de48-423f-9926-8e192e5de59d",
  "deleted": false,
  "owners": [],
  "tags": [],
  "domains": []
}

​
Returns

Returns the updated dashboard object with the new version number.

​
Response

​
id
string
Unique identifier for the dashboard (UUID format).
​
name
string
Dashboard name.
​
fullyQualifiedName
string
Fully qualified name in format service.dashboardName.
​
description
string
Updated description.
​
version
number
Incremented version number.

​
Error Handling

CodeError TypeDescription
400BAD_REQUESTInvalid JSON patch or malformed request
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to update this dashboard
404NOT_FOUNDDashboard with given ID or FQN does not exist
409CONFLICTConcurrent modification detected