Sign in
OpenAPI 3.1.02026-08-19313314398.5 KB

f2927c00c4d9

databases

Update Database

Update a database's name, description, schema, or sharing.

patch/api/v1/databases/{database_id}

Path parameters

database_idstring uuid required

Request body

namestring nullable
schema_infoobject[] nullable
is_sharedboolean nullable

Response

Successful Response

idstring uuid required
company_idstring uuid required
project_idstring uuid nullable
integration_idstring uuid nullable
user_idstring uuid required
namestring required
descriptionstring required
table_namestring required
storage_pathstring nullable required
schema_infoobject[] required
key_columnsstring[]
source_step_idstring uuid nullable
source_user_file_idstring uuid nullable
source_automation_idstring uuid nullable
source_sheet_namestring nullable
source_kindstring
is_sharedboolean required
is_suppressedboolean required
refresh_statusstring required
refresh_errorstring nullable
last_refreshed_atstring date-time nullable required
name_is_user_overriddenboolean
row_countinteger required
size_bytesinteger required
created_atstring date-time required
updated_atstring date-time required
doc_statusstring
doc_status_updated_atstring date-time nullable
doc_last_errorstring nullable