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

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

# Retrieve, modify, and update
service = DatabaseServices.retrieve("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
service.description = "Updated production Snowflake warehouse"
service.displayName = "Snowflake Prod (Updated)"
updated = DatabaseServices.update(service)

print(f"Updated to version {updated.version}")

{
  "id": "fd2193af-fe09-4366-92b7-1e0d01cd8c09",
  "name": "sample_data",
  "fullyQualifiedName": "sample_data",
  "serviceType": "BigQuery",
  "description": "Updated BigQuery data service",
  "version": 0.2,
  "updatedAt": 1769982700000,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/databaseServices/fd2193af-fe09-4366-92b7-1e0d01cd8c09",
  "connection": {
    "config": {
      "type": "BigQuery",
      "scheme": "bigquery",
      "hostPort": "bigquery.googleapis.com",
      "taxonomyProjectID": [],
      "taxonomyLocation": "us",
      "usageLocation": "us",
      "supportsMetadataExtraction": true,
      "supportsUsageExtraction": true,
      "supportsLineageExtraction": true,
      "supportsDBTExtraction": true,
      "supportsProfiler": true,
      "supportsQueryComment": true
    }
  },
  "owners": [],
  "tags": [],
  "deleted": false,
  "domains": [],
  "entityStatus": "Unprocessed"
}

​
Update a Database Service

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

​
Update by Name

Use PATCH /v1/services/databaseServices/name/{fqn} to update by fully qualified name.
​
fqn
string
required
Fully qualified name of the database service (e.g., snowflake_prod).

​
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/databaseServices/{id}
from metadata.sdk import configure
from metadata.sdk.entities import DatabaseServices

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

# Retrieve, modify, and update
service = DatabaseServices.retrieve("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
service.description = "Updated production Snowflake warehouse"
service.displayName = "Snowflake Prod (Updated)"
updated = DatabaseServices.update(service)

print(f"Updated to version {updated.version}")

{
  "id": "fd2193af-fe09-4366-92b7-1e0d01cd8c09",
  "name": "sample_data",
  "fullyQualifiedName": "sample_data",
  "serviceType": "BigQuery",
  "description": "Updated BigQuery data service",
  "version": 0.2,
  "updatedAt": 1769982700000,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/databaseServices/fd2193af-fe09-4366-92b7-1e0d01cd8c09",
  "connection": {
    "config": {
      "type": "BigQuery",
      "scheme": "bigquery",
      "hostPort": "bigquery.googleapis.com",
      "taxonomyProjectID": [],
      "taxonomyLocation": "us",
      "usageLocation": "us",
      "supportsMetadataExtraction": true,
      "supportsUsageExtraction": true,
      "supportsLineageExtraction": true,
      "supportsDBTExtraction": true,
      "supportsProfiler": true,
      "supportsQueryComment": true
    }
  },
  "owners": [],
  "tags": [],
  "deleted": false,
  "domains": [],
  "entityStatus": "Unprocessed"
}

​
Returns

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

​
Response

​
id
string
Unique identifier for the database service (UUID format).
​
name
string
Database 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 database service
404NOT_FOUNDDatabase service with given ID or FQN does not exist
409CONFLICTConcurrent modification detected