POST /v1/services/dashboardServices

from metadata.sdk import configure
import requests

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

# Direct API call for dashboard services
response = requests.post(
    "https://your-company.getcollate.io/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']}")

import org.openmetadata.schema.api.data.CreateDashboardDataModel.DashboardServiceType;
import org.openmetadata.schema.api.services.CreateDashboardService;
import org.openmetadata.schema.entity.services.DashboardService;
import org.openmetadata.schema.services.connections.dashboard.LookerConnection;
import org.openmetadata.schema.type.DashboardConnection;
import org.openmetadata.sdk.fluent.DashboardServices;
import java.net.URI;
// client is an initialized OpenMetadataClient.
DashboardServices.setDefaultClient(client);

CreateDashboardService request = new CreateDashboardService()
    .withName("sample_looker")
    .withDisplayName("Sample Looker")
    .withServiceType(DashboardServiceType.Looker)
    .withDescription("Production Looker instance")
    .withConnection(new DashboardConnection().withConfig(
        new LookerConnection()
            .withClientId("your-client-id")
            .withClientSecret("***")
            .withHostPort(URI.create("https://looker.example.com:443"))));

DashboardService service = DashboardServices.create(request);

curl -X POST "{base_url}/api/v1/services/dashboardServices" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "sample_looker",
    "serviceType": "Looker",
    "description": "Production Looker instance",
    "connection": {
      "config": {
        "type": "Looker",
        "clientId": "your-client-id",
        "clientSecret": "***",
        "hostPort": "https://looker.example.com:443"
      }
    }
  }'

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

POST

services

dashboardServices

POST /v1/services/dashboardServices

from metadata.sdk import configure
import requests

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

# Direct API call for dashboard services
response = requests.post(
    "https://your-company.getcollate.io/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']}")

import org.openmetadata.schema.api.data.CreateDashboardDataModel.DashboardServiceType;
import org.openmetadata.schema.api.services.CreateDashboardService;
import org.openmetadata.schema.entity.services.DashboardService;
import org.openmetadata.schema.services.connections.dashboard.LookerConnection;
import org.openmetadata.schema.type.DashboardConnection;
import org.openmetadata.sdk.fluent.DashboardServices;
import java.net.URI;
// client is an initialized OpenMetadataClient.
DashboardServices.setDefaultClient(client);

CreateDashboardService request = new CreateDashboardService()
    .withName("sample_looker")
    .withDisplayName("Sample Looker")
    .withServiceType(DashboardServiceType.Looker)
    .withDescription("Production Looker instance")
    .withConnection(new DashboardConnection().withConfig(
        new LookerConnection()
            .withClientId("your-client-id")
            .withClientSecret("***")
            .withHostPort(URI.create("https://looker.example.com:443"))));

DashboardService service = DashboardServices.create(request);

curl -X POST "{base_url}/api/v1/services/dashboardServices" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "sample_looker",
    "serviceType": "Looker",
    "description": "Production Looker instance",
    "connection": {
      "config": {
        "type": "Looker",
        "clientId": "your-client-id",
        "clientSecret": "***",
        "hostPort": "https://looker.example.com:443"
      }
    }
  }'

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

Create a Dashboard Service

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

Body Parameters

string

required

Name of the dashboard service. Must be unique across all dashboard services.

string

required

Type of dashboard service, for example Superset, Looker, Tableau, Metabase, Redash, PowerBI, Mode, QlikSense, QlikCloud, Lightdash, DomoDashboard, CustomDashboard.

string

Description of the dashboard service in Markdown format.

string

Human-readable display name for the dashboard service.

object

Connection configuration specific to the service type.

Show properties

object

Service-specific connection configuration, for example hostPort, username, and password for Superset.

array

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

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 service.

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.

POST /v1/services/dashboardServices

from metadata.sdk import configure
import requests

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

# Direct API call for dashboard services
response = requests.post(
    "https://your-company.getcollate.io/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']}")

import org.openmetadata.schema.api.data.CreateDashboardDataModel.DashboardServiceType;
import org.openmetadata.schema.api.services.CreateDashboardService;
import org.openmetadata.schema.entity.services.DashboardService;
import org.openmetadata.schema.services.connections.dashboard.LookerConnection;
import org.openmetadata.schema.type.DashboardConnection;
import org.openmetadata.sdk.fluent.DashboardServices;
import java.net.URI;
// client is an initialized OpenMetadataClient.
DashboardServices.setDefaultClient(client);

CreateDashboardService request = new CreateDashboardService()
    .withName("sample_looker")
    .withDisplayName("Sample Looker")
    .withServiceType(DashboardServiceType.Looker)
    .withDescription("Production Looker instance")
    .withConnection(new DashboardConnection().withConfig(
        new LookerConnection()
            .withClientId("your-client-id")
            .withClientSecret("***")
            .withHostPort(URI.create("https://looker.example.com:443"))));

DashboardService service = DashboardServices.create(request);

curl -X POST "{base_url}/api/v1/services/dashboardServices" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "sample_looker",
    "serviceType": "Looker",
    "description": "Production Looker instance",
    "connection": {
      "config": {
        "type": "Looker",
        "clientId": "your-client-id",
        "clientSecret": "***",
        "hostPort": "https://looker.example.com:443"
      }
    }
  }'

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

string

Unique identifier for the dashboard service (UUID format).

string

Dashboard service name.

string

Fully qualified name of the service.

string

Human-readable display name.

string

Description of the dashboard service in Markdown format.

string

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

object

Connection configuration for the service.

Show properties

object

Service-specific connection configuration.

array

List of owners assigned to the dashboard service.

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 assigned domains.

array

Classification tags applied to the dashboard service.

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.

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 ... }'

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/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

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 dashboard services
`409`	`ENTITY_ALREADY_EXISTS`	Dashboard service with same name already exists (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 Service

Create a Dashboard Service

Body Parameters

Returns

Response

Create or Update (PUT)

Bulk Create or Update (PUT)

Error Handling