POST /v1/dashboards

from metadata.sdk import configure
from metadata.sdk.entities import Dashboards
from metadata.generated.schema.api.data.createDashboard import CreateDashboardRequest

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

request = CreateDashboardRequest(
    name="10",
    displayName="deck.gl Demo",
    service="sample_superset",
    description="Dashboard showcasing deck.gl visualizations",
    sourceUrl="http://localhost:808/superset/dashboard/10/"
)

dashboard = Dashboards.create(request)
print(f"Created: {dashboard.fullyQualifiedName.root}")

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

// client is an initialized OpenMetadataClient.

CreateDashboard request = new CreateDashboard()
    .withName("10")
    .withDisplayName("deck.gl Demo")
    .withService("sample_superset")
    .withDescription("Dashboard showcasing deck.gl visualizations")
    .withSourceUrl("http://localhost:808/superset/dashboard/10/");

Dashboard dashboard = client.dashboards().create(request);

curl -X POST "{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/"
  }'

{
  "id": "03fb5cc3-de48-423f-9926-8e192e5de59d",
  "name": "10",
  "displayName": "deck.gl Demo",
  "fullyQualifiedName": "sample_superset.10",
  "description": "Dashboard showcasing deck.gl visualizations",
  "version": 0.1,
  "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": [],
  "followers": [],
  "votes": {
    "upVotes": 0,
    "downVotes": 0
  },
  "domains": [],
  "charts": []
}

POST

dashboards

POST /v1/dashboards

from metadata.sdk import configure
from metadata.sdk.entities import Dashboards
from metadata.generated.schema.api.data.createDashboard import CreateDashboardRequest

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

request = CreateDashboardRequest(
    name="10",
    displayName="deck.gl Demo",
    service="sample_superset",
    description="Dashboard showcasing deck.gl visualizations",
    sourceUrl="http://localhost:808/superset/dashboard/10/"
)

dashboard = Dashboards.create(request)
print(f"Created: {dashboard.fullyQualifiedName.root}")

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

// client is an initialized OpenMetadataClient.

CreateDashboard request = new CreateDashboard()
    .withName("10")
    .withDisplayName("deck.gl Demo")
    .withService("sample_superset")
    .withDescription("Dashboard showcasing deck.gl visualizations")
    .withSourceUrl("http://localhost:808/superset/dashboard/10/");

Dashboard dashboard = client.dashboards().create(request);

curl -X POST "{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/"
  }'

{
  "id": "03fb5cc3-de48-423f-9926-8e192e5de59d",
  "name": "10",
  "displayName": "deck.gl Demo",
  "fullyQualifiedName": "sample_superset.10",
  "description": "Dashboard showcasing deck.gl visualizations",
  "version": 0.1,
  "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": [],
  "followers": [],
  "votes": {
    "upVotes": 0,
    "downVotes": 0
  },
  "domains": [],
  "charts": []
}

Create a Dashboard

Create a new dashboard within a dashboard service.

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.

POST /v1/dashboards

from metadata.sdk import configure
from metadata.sdk.entities import Dashboards
from metadata.generated.schema.api.data.createDashboard import CreateDashboardRequest

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

request = CreateDashboardRequest(
    name="10",
    displayName="deck.gl Demo",
    service="sample_superset",
    description="Dashboard showcasing deck.gl visualizations",
    sourceUrl="http://localhost:808/superset/dashboard/10/"
)

dashboard = Dashboards.create(request)
print(f"Created: {dashboard.fullyQualifiedName.root}")

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

// client is an initialized OpenMetadataClient.

CreateDashboard request = new CreateDashboard()
    .withName("10")
    .withDisplayName("deck.gl Demo")
    .withService("sample_superset")
    .withDescription("Dashboard showcasing deck.gl visualizations")
    .withSourceUrl("http://localhost:808/superset/dashboard/10/");

Dashboard dashboard = client.dashboards().create(request);

curl -X POST "{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/"
  }'

{
  "id": "03fb5cc3-de48-423f-9926-8e192e5de59d",
  "name": "10",
  "displayName": "deck.gl Demo",
  "fullyQualifiedName": "sample_superset.10",
  "description": "Dashboard showcasing deck.gl visualizations",
  "version": 0.1,
  "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": [],
  "followers": [],
  "votes": {
    "upVotes": 0,
    "downVotes": 0
  },
  "domains": [],
  "charts": []
}

Returns

Returns the created dashboard object with all specified properties and system-generated fields.

Response

string

Unique identifier for the dashboard (UUID format).

string

Dashboard name.

string

Fully qualified name in format service.dashboardName.

string

Human-readable display name.

string

Description of the dashboard in Markdown format.

object

Reference to the parent dashboard service.

Show properties

string

UUID of the dashboard service.

string

Type of entity (always dashboardService).

string

Name of the dashboard service.

string

Fully qualified name of the dashboard service.

string

URL of the dashboard in the source system.

string

Type of dashboard service, for example Superset, Looker, Tableau, Metabase, PowerBI.

array

List of charts associated with the dashboard.

array

List of owners assigned 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

Domain assignments for governance.

array

Classification tags applied to the dashboard.

Show properties

string

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.

number

Version number for the entity (starts at 0.1).

Create or Update (PUT)

Use PUT /v1/dashboards instead of POST to perform an upsert. If a dashboard with the same fullyQualifiedName already exists, it will be updated; otherwise, a new dashboard is created. The request body is the same as POST.

curl -X PUT "{base_url}/api/v1/dashboards" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{ ... same body as POST ... }'

Note: PUT will not return a 409 conflict error if the entity already exists — it will update the existing entity instead. However, for certain fields (such as description, tags, owners, and custom properties), PUT preserves an already-populated value instead of overwriting it with an empty or omitted one — the exact behavior depends on the field and the calling user or bot’s permissions, not a blanket rule. See Entity Update Behavior for the full preserve/merge rules. Use PATCH to intentionally replace an existing value.

Bulk Create or Update (PUT)

Use PUT /v1/dashboards/bulk to create or update multiple dashboards in a single request. The request body is an array of create request objects.

curl -X PUT "{base_url}/api/v1/dashboards/bulk" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '[
    { "name": "dashboard_one", "service": "sample_superset" },
    { "name": "dashboard_two", "service": "sample_superset" }
  ]'

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid request body or missing required fields
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to create dashboards
`409`	`ENTITY_ALREADY_EXISTS`	Dashboard with same name already exists in service (POST only)

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

Create a Dashboard

Create a Dashboard

Body Parameters

Returns

Response

Create or Update (PUT)

Bulk Create or Update (PUT)

Error Handling