Skip to main content
PATCH
https://sandbox.getcollate.io/api
/
v1
/
services
/
dashboardServices
/
{id}
PATCH /v1/services/dashboardServices/{id}
from metadata.sdk import configure
import requests

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

# Update by ID using JSON Patch
response = requests.patch(
    "https://your-company.getcollate.io/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']}")

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

​
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.
​
fqn
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.
​
description
string
Updated description in Markdown format.
​
displayName
string
Updated display name.
​
connection
object
Updated connection configuration.
​
owners
array
Updated list of owner references.
​
tags
array
Updated classification tags.
​
domain
string
Updated domain FQN.
PATCH /v1/services/dashboardServices/{id}
from metadata.sdk import configure
import requests

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

# Update by ID using JSON Patch
response = requests.patch(
    "https://your-company.getcollate.io/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']}")

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

​
id
string
Unique identifier for the dashboard service (UUID format).
​
name
string
Dashboard service name.
​
fullyQualifiedName
string
Fully qualified name of the service.
​
description
string
Updated description.
​
version
number
Incremented version number.

​
Error Handling

CodeError TypeDescription
400BAD_REQUESTInvalid JSON patch or malformed request
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to update this dashboard service
404NOT_FOUNDDashboard service with given ID or FQN does not exist
409CONFLICTConcurrent modification detected