Skip to main content
PUT
PUT /v1/databases

Update a Database

Create a database or update it if it already exists, using PUT /v1/databases 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. Must be unique within the parent service.
string
required
Fully qualified name of the parent DatabaseService.
string
Human-readable display name for the database.
string
Description of the database in Markdown format.
string
Data retention period in ISO 8601 duration format, for example P365D.
array
Array of owner references (users or teams) to assign to the database.
array
Fully qualified names of the domains to assign for governance purposes.
array
Array of classification tags to apply to the database.
object
Custom property values defined by your organization’s metadata schema.
PUT /v1/databases

Returns

Returns the updated database object with the new version number.

Response

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

Error Handling