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.root}")

import org.openmetadata.schema.entity.data.Dashboard;

// client is an initialized OpenMetadataClient.

// Retrieve, modify, and update
Dashboard dashboard = client.dashboards().get("03fb5cc3-de48-423f-9926-8e192e5de59d");
dashboard.setDescription("Updated: deck.gl Demo dashboard with new visualizations");
Dashboard updated = client.dashboards().update("03fb5cc3-de48-423f-9926-8e192e5de59d", dashboard);

# Update by ID
curl -X PATCH "{base_url}/api/v1/dashboards/03fb5cc3-de48-423f-9926-8e192e5de59d" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: deck.gl Demo dashboard with new visualizations"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/dashboards/name/sample_superset.10" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: deck.gl Demo dashboard with new visualizations"}
  ]'

{
  "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": []
}

PATCH

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.root}")

import org.openmetadata.schema.entity.data.Dashboard;

// client is an initialized OpenMetadataClient.

// Retrieve, modify, and update
Dashboard dashboard = client.dashboards().get("03fb5cc3-de48-423f-9926-8e192e5de59d");
dashboard.setDescription("Updated: deck.gl Demo dashboard with new visualizations");
Dashboard updated = client.dashboards().update("03fb5cc3-de48-423f-9926-8e192e5de59d", dashboard);

# Update by ID
curl -X PATCH "{base_url}/api/v1/dashboards/03fb5cc3-de48-423f-9926-8e192e5de59d" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: deck.gl Demo dashboard with new visualizations"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/dashboards/name/sample_superset.10" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: deck.gl Demo dashboard with new visualizations"}
  ]'

{
  "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

string

required

UUID of the dashboard to update.

Update by Name

Use PATCH /v1/dashboards/name/{fqn} to update by fully qualified name.

string

required

Fully qualified name of the dashboard, for example sample_superset.10.

Body Parameters

Send a JSON object with the fields to update. Only provided fields are changed.

string

Updated description in Markdown format.

string

Updated display name.

string

Updated source URL.

array

Updated list of chart references.

array

Updated list of owner references.

Show properties

string

UUID of the owner entity.

string

Type of owner entity, for example user, team.

array

Updated classification tags.

Show properties

string

required

Fully qualified name of the tag.

string

Type of label, for example Manual, Derived, Propagated.

string

State of the tag, for example Suggested, Confirmed.

array

Updated domains, as fully qualified names.

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.root}")

import org.openmetadata.schema.entity.data.Dashboard;

// client is an initialized OpenMetadataClient.

// Retrieve, modify, and update
Dashboard dashboard = client.dashboards().get("03fb5cc3-de48-423f-9926-8e192e5de59d");
dashboard.setDescription("Updated: deck.gl Demo dashboard with new visualizations");
Dashboard updated = client.dashboards().update("03fb5cc3-de48-423f-9926-8e192e5de59d", dashboard);

# Update by ID
curl -X PATCH "{base_url}/api/v1/dashboards/03fb5cc3-de48-423f-9926-8e192e5de59d" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: deck.gl Demo dashboard with new visualizations"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/dashboards/name/sample_superset.10" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: deck.gl Demo dashboard with new visualizations"}
  ]'

{
  "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

string

Unique identifier for the dashboard (UUID format).

string

Dashboard name.

string

Fully qualified name in format service.dashboardName.

string

Updated description.

number

Incremented version number.

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid JSON patch or malformed request
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to update this dashboard
`404`	`NOT_FOUND`	Dashboard with given ID or FQN does not exist
`409`	`CONFLICT`	Concurrent modification detected

API Reference

SDK

API

Data Assets

AI Assets

Discovery

Lineage

Data Contracts

Teams & Users

Data Governance

Data Quality

Alerts

Incidents

Billing

Query Runner

Context Plugins

Standards

Update a Dashboard

Update a Dashboard

Update by ID

Update by Name

Body Parameters

Returns

Response

Error Handling