Skip to main content
PUT
PUT /v1/services/databaseServices

Update a Database Service

Create a database service or update it if it already exists, using PUT /v1/services/databaseServices with the full request body. Send the complete definition, not just the fields you want to change. To change only some fields, use PATCH with a JSON Patch array and the application/json-patch+json content type, as shown in the PATCH examples below.

Body Parameters

string
required
Name of the database service. Must be unique across all database services.
string
required
Type of database service, for example Snowflake, BigQuery, Postgres, Mysql, Redshift, Databricks.
string
Description of the database service in Markdown format.
string
Human-readable display name for the database service.
object
Connection configuration specific to the service type.
array
Array of owner references (users or teams) to assign to the service.
array
Fully qualified names of the domains to assign for governance purposes.
array
Array of classification tags to apply to the database service.
PUT /v1/services/databaseServices

Returns

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

Response

string
Unique identifier for the database service (UUID format).
string
Database service name.
string
Fully qualified name of the service.
string
Updated description.
number
Incremented version number.

Error Handling