PATCH /v1/services/dashboardServices/{id}

from metadata.sdk import configure
import requests

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

# Update by ID using JSON Patch
response = requests.patch(
    "https://your-company.open-metadata.org/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd",
    headers={
        "Authorization": "Bearer your-jwt-token",
        "Content-Type": "application/json-patch+json"
    },
    json=[
        {"op": "replace", "path": "/description", "value": "Updated Looker production instance"}
    ]
)

service = response.json()
print(f"Updated to version {service['version']}")

import static org.openmetadata.sdk.fluent.DashboardServices.*;

// Retrieve, modify, and update
var svc = DashboardServices.retrieve("2c0c7c05-d820-4bea-a471-047deb7f92fd");
svc.setDescription("Updated Looker production instance");
var updated = DashboardServices.update(svc);

# Update by ID
curl -X PATCH "{base_url}/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated Looker production instance"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/services/dashboardServices/name/sample_looker" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated Looker production instance"}
  ]'

{
  "id": "2c0c7c05-d820-4bea-a471-047deb7f92fd",
  "name": "sample_looker",
  "fullyQualifiedName": "sample_looker",
  "serviceType": "Looker",
  "description": "Updated Looker production instance",
  "version": 0.2,
  "updatedAt": 1769982621219,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd",
  "deleted": false,
  "owners": [],
  "tags": [],
  "domains": []
}

PATCH

services

dashboardServices

{id}

PATCH /v1/services/dashboardServices/{id}

from metadata.sdk import configure
import requests

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

# Update by ID using JSON Patch
response = requests.patch(
    "https://your-company.open-metadata.org/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd",
    headers={
        "Authorization": "Bearer your-jwt-token",
        "Content-Type": "application/json-patch+json"
    },
    json=[
        {"op": "replace", "path": "/description", "value": "Updated Looker production instance"}
    ]
)

service = response.json()
print(f"Updated to version {service['version']}")

import static org.openmetadata.sdk.fluent.DashboardServices.*;

// Retrieve, modify, and update
var svc = DashboardServices.retrieve("2c0c7c05-d820-4bea-a471-047deb7f92fd");
svc.setDescription("Updated Looker production instance");
var updated = DashboardServices.update(svc);

# Update by ID
curl -X PATCH "{base_url}/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated Looker production instance"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/services/dashboardServices/name/sample_looker" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated Looker production instance"}
  ]'

{
  "id": "2c0c7c05-d820-4bea-a471-047deb7f92fd",
  "name": "sample_looker",
  "fullyQualifiedName": "sample_looker",
  "serviceType": "Looker",
  "description": "Updated Looker production instance",
  "version": 0.2,
  "updatedAt": 1769982621219,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd",
  "deleted": false,
  "owners": [],
  "tags": [],
  "domains": []
}

Update a Dashboard Service

Update a dashboard service’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 service to update.

Update by Name

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

string

required

Fully qualified name of the dashboard service (e.g., sample_looker).

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.

object

Updated connection configuration.

Show properties

object

Service-specific connection configuration.

array

Updated list of owner references.

Show properties

string

UUID of the owner entity.

string

Type of owner entity (e.g., user, team).

array

Updated classification tags.

Show properties

string

required

Fully qualified name of the tag.

string

Type of label (e.g., Manual, Derived, Propagated).

string

State of the tag (e.g., Suggested, Confirmed).

string

Updated domain FQN.

PATCH /v1/services/dashboardServices/{id}

from metadata.sdk import configure
import requests

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

# Update by ID using JSON Patch
response = requests.patch(
    "https://your-company.open-metadata.org/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd",
    headers={
        "Authorization": "Bearer your-jwt-token",
        "Content-Type": "application/json-patch+json"
    },
    json=[
        {"op": "replace", "path": "/description", "value": "Updated Looker production instance"}
    ]
)

service = response.json()
print(f"Updated to version {service['version']}")

import static org.openmetadata.sdk.fluent.DashboardServices.*;

// Retrieve, modify, and update
var svc = DashboardServices.retrieve("2c0c7c05-d820-4bea-a471-047deb7f92fd");
svc.setDescription("Updated Looker production instance");
var updated = DashboardServices.update(svc);

# Update by ID
curl -X PATCH "{base_url}/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated Looker production instance"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/services/dashboardServices/name/sample_looker" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated Looker production instance"}
  ]'

{
  "id": "2c0c7c05-d820-4bea-a471-047deb7f92fd",
  "name": "sample_looker",
  "fullyQualifiedName": "sample_looker",
  "serviceType": "Looker",
  "description": "Updated Looker production instance",
  "version": 0.2,
  "updatedAt": 1769982621219,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd",
  "deleted": false,
  "owners": [],
  "tags": [],
  "domains": []
}

Returns

Returns the updated dashboard service object with the new version number.

Response

string

Unique identifier for the dashboard service (UUID format).

string

Dashboard service name.

string

Fully qualified name of the service.

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 service
`404`	`NOT_FOUND`	Dashboard service with given ID or FQN does not exist
`409`	`CONFLICT`	Concurrent modification detected

API Reference

Data Assets

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Main Concepts

Update a Dashboard Service

Update a Dashboard Service

Update by ID

Update by Name

Body Parameters

Returns

Response

Error Handling

​Update a Dashboard Service

​Update by ID

​Update by Name

​Body Parameters

​Returns

​Response

​Error Handling

Update a Dashboard Service

Update by ID

Update by Name

Body Parameters

Returns

Response

Error Handling