PUT /v1/dashboards

curl -X PUT "{base_url}/api/v1/dashboards" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "10",
    "displayName": "deck.gl Demo",
    "service": "sample_superset",
    "description": "Dashboard showcasing deck.gl visualizations",
    "sourceUrl": "http://localhost:808/superset/dashboard/10/"
  }'

from metadata.sdk import configure
from metadata.sdk.entities import Dashboards

configure(
    host="https://your-company.open-metadata.org/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": []
}

PUT

dashboards

PUT /v1/dashboards

curl -X PUT "{base_url}/api/v1/dashboards" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "10",
    "displayName": "deck.gl Demo",
    "service": "sample_superset",
    "description": "Dashboard showcasing deck.gl visualizations",
    "sourceUrl": "http://localhost:808/superset/dashboard/10/"
  }'

from metadata.sdk import configure
from metadata.sdk.entities import Dashboards

configure(
    host="https://your-company.open-metadata.org/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

Create a dashboard or update it if it already exists, using PUT /v1/dashboards 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. Must be unique within the parent dashboard service.

string

required

Fully qualified name of the parent DashboardService, for example sample_superset.

string

Human-readable display name for the dashboard.

string

Description of the dashboard in Markdown format.

string

URL of the dashboard in the source system.

array

Array of chart fully qualified names to associate with the dashboard.

array

Array of owner references (users or teams) to assign to the dashboard.

Show properties

string

UUID of the owner entity.

string

Type of owner entity, for example user, team.

string

Name of the owner entity.

array

Fully qualified names of the domains to assign for governance purposes.

array

Array of classification tags to apply to the dashboard.

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.

object

Custom property values defined by your organization’s metadata schema.

PUT /v1/dashboards

curl -X PUT "{base_url}/api/v1/dashboards" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "10",
    "displayName": "deck.gl Demo",
    "service": "sample_superset",
    "description": "Dashboard showcasing deck.gl visualizations",
    "sourceUrl": "http://localhost:808/superset/dashboard/10/"
  }'

from metadata.sdk import configure
from metadata.sdk.entities import Dashboards

configure(
    host="https://your-company.open-metadata.org/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 or malformed request body
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to update this dashboard
`409`	`CONFLICT`	Concurrent modification detected

API Reference

Data Assets

Collaboration

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Alerts

Incidents

Main Concepts

Update a Dashboard

Update a Dashboard

Body Parameters

Returns

Response

Error Handling