Skip to main content
POST
/
v1
/
services
/
dashboardServices
POST /v1/services/dashboardServices
from metadata.sdk import configure
import requests

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Direct API call for dashboard services
response = requests.post(
    "https://your-company.open-metadata.org/api/v1/services/dashboardServices",
    headers={"Authorization": "Bearer your-jwt-token"},
    json={
        "name": "sample_looker",
        "displayName": "Sample Looker",
        "serviceType": "Looker",
        "description": "Production Looker instance",
        "connection": {
            "config": {
                "type": "Looker",
                "clientId": "your-client-id",
                "clientSecret": "***",
                "hostPort": "https://looker.example.com:443"
            }
        }
    }
)

service = response.json()
print(f"Created: {service['fullyQualifiedName']}")

{
  "id": "2c0c7c05-d820-4bea-a471-047deb7f92fd",
  "name": "sample_looker",
  "fullyQualifiedName": "sample_looker",
  "serviceType": "Looker",
  "description": "Production Looker instance",
  "version": 0.1,
  "updatedAt": 1769982621219,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd",
  "connection": {
    "config": {
      "type": "Looker",
      "clientId": "your-client-id",
      "clientSecret": "***",
      "hostPort": "https://looker.example.com:443"
    }
  },
  "owners": [],
  "tags": [],
  "deleted": false,
  "domains": []
}

Documentation Index

Fetch the complete documentation index at: https://openmetadata-codex-audit-docs-codebase-alignment.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Create a Dashboard Service

Create a new dashboard service connection to a platform such as Superset, Looker, or Tableau.

​
Body Parameters

​
name
string
required
Name of the dashboard service. Must be unique across all dashboard services.
​
serviceType
string
required
Type of dashboard service (e.g., Superset, Looker, Tableau, Metabase, Redash, PowerBI, Mode, QlikSense, QlikCloud, Lightdash, DomoDashboard, CustomDashboard).
​
description
string
Description of the dashboard service in Markdown format.
​
displayName
string
Human-readable display name for the dashboard service.
​
connection
object
Connection configuration specific to the service type.
​
owners
array
Array of owner references (users or teams) to assign to the service.
​
domain
string
Fully qualified name of the domain to assign for governance purposes.
​
tags
array
Array of classification tags to apply to the dashboard service.
POST /v1/services/dashboardServices
from metadata.sdk import configure
import requests

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Direct API call for dashboard services
response = requests.post(
    "https://your-company.open-metadata.org/api/v1/services/dashboardServices",
    headers={"Authorization": "Bearer your-jwt-token"},
    json={
        "name": "sample_looker",
        "displayName": "Sample Looker",
        "serviceType": "Looker",
        "description": "Production Looker instance",
        "connection": {
            "config": {
                "type": "Looker",
                "clientId": "your-client-id",
                "clientSecret": "***",
                "hostPort": "https://looker.example.com:443"
            }
        }
    }
)

service = response.json()
print(f"Created: {service['fullyQualifiedName']}")

{
  "id": "2c0c7c05-d820-4bea-a471-047deb7f92fd",
  "name": "sample_looker",
  "fullyQualifiedName": "sample_looker",
  "serviceType": "Looker",
  "description": "Production Looker instance",
  "version": 0.1,
  "updatedAt": 1769982621219,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd",
  "connection": {
    "config": {
      "type": "Looker",
      "clientId": "your-client-id",
      "clientSecret": "***",
      "hostPort": "https://looker.example.com:443"
    }
  },
  "owners": [],
  "tags": [],
  "deleted": false,
  "domains": []
}

​
Returns

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

​
Response

​
id
string
Unique identifier for the dashboard service (UUID format).
​
name
string
Dashboard service name.
​
fullyQualifiedName
string
Fully qualified name of the service.
​
displayName
string
Human-readable display name.
​
description
string
Description of the dashboard service in Markdown format.
​
serviceType
string
Type of dashboard service (e.g., Superset, Looker, Tableau, Metabase, PowerBI).
​
connection
object
Connection configuration for the service.
​
owners
array
List of owners assigned to the dashboard service.
​
domain
string
Fully qualified name of the assigned domain.
​
tags
array
Classification tags applied to the dashboard service.
​
version
number
Version number for the entity (starts at 0.1).

​
Create or Update (PUT)

Use PUT /v1/services/dashboardServices instead of POST to perform an upsert. If a dashboard service with the same fullyQualifiedName already exists, it will be updated; otherwise, a new service is created. The request body is the same as POST. 
curl -X PUT "{base_url}/api/v1/services/dashboardServices" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{ ... same body as POST ... }'
PUT will not return a 409 conflict error if the entity already exists — it will update the existing entity instead.

​
Bulk Create or Update (PUT)

Use PUT /v1/services/dashboardServices/bulk to create or update multiple dashboard services in a single request. The request body is an array of create request objects. 
curl -X PUT "{base_url}/api/v1/services/dashboardServices/bulk" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '[
    { "name": "service_one", "serviceType": "Superset", "connection": { "config": {} } },
    { "name": "service_two", "serviceType": "Looker", "connection": { "config": {} } }
  ]'

​
Error Handling

CodeError TypeDescription
400BAD_REQUESTInvalid request body or missing required fields
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to create dashboard services
409ENTITY_ALREADY_EXISTSDashboard service with same name already exists (POST only)