Skip to main content
DELETE
https://sandbox.getcollate.io/api
/
v1
/
services
/
databaseServices
/
{id}
DELETE /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"
)

# Soft delete by ID
DatabaseServices.delete("a1b2c3d4-e5f6-7890-abcd-ef1234567890")

# Hard delete with recursive
DatabaseServices.delete(
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    recursive=True,
    hard_delete=True
)

# Delete by name
DatabaseServices.delete_by_name("snowflake_prod")

# Delete by name with options
DatabaseServices.delete_by_name(
    "snowflake_prod",
    recursive=True,
    hard_delete=True
)

# Restore a soft-deleted database service
DatabaseServices.restore("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
{
  "id": "fd2193af-fe09-4366-92b7-1e0d01cd8c09",
  "name": "sample_data",
  "fullyQualifiedName": "sample_data",
  "serviceType": "BigQuery",
  "description": "Sample data service for BigQuery",
  "version": 0.2,
  "updatedAt": 1769982750000,
  "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",
      "supportsMetadataExtraction": true,
      "supportsProfiler": true,
      "supportsQueryComment": true
    }
  },
  "owners": [],
  "tags": [],
  "deleted": true,
  "domains": [],
  "entityStatus": "Unprocessed"
}

Delete a Database Service

Delete a database service by ID or fully qualified name. Supports soft delete (default), hard delete, and restore operations.

Delete by ID

id
string
required
UUID of the database service to delete.
recursive
boolean
default:"false"
Recursively delete child databases, schemas, and tables.
hardDelete
boolean
default:"false"
Permanently delete the database service. If false, the service is soft-deleted and can be restored.

Delete by Name

Use DELETE /v1/services/databaseServices/name/{fqn} to delete by fully qualified name.
fqn
string
required
Fully qualified name of the database service (e.g., snowflake_prod).
recursive
boolean
default:"false"
Recursively delete child databases, schemas, and tables.
hardDelete
boolean
default:"false"
Permanently delete the database service.

Restore a Soft-Deleted Database Service

Use PUT /v1/services/databaseServices/restore to restore a soft-deleted database service.
id
string
required
UUID of the soft-deleted database service to restore.
DELETE /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"
)

# Soft delete by ID
DatabaseServices.delete("a1b2c3d4-e5f6-7890-abcd-ef1234567890")

# Hard delete with recursive
DatabaseServices.delete(
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    recursive=True,
    hard_delete=True
)

# Delete by name
DatabaseServices.delete_by_name("snowflake_prod")

# Delete by name with options
DatabaseServices.delete_by_name(
    "snowflake_prod",
    recursive=True,
    hard_delete=True
)

# Restore a soft-deleted database service
DatabaseServices.restore("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
{
  "id": "fd2193af-fe09-4366-92b7-1e0d01cd8c09",
  "name": "sample_data",
  "fullyQualifiedName": "sample_data",
  "serviceType": "BigQuery",
  "description": "Sample data service for BigQuery",
  "version": 0.2,
  "updatedAt": 1769982750000,
  "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",
      "supportsMetadataExtraction": true,
      "supportsProfiler": true,
      "supportsQueryComment": true
    }
  },
  "owners": [],
  "tags": [],
  "deleted": true,
  "domains": [],
  "entityStatus": "Unprocessed"
}

Returns

Soft delete returns the database service object with deleted: true. Hard delete returns no content (204). Restore returns the restored database service object.

Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to delete this database service
404NOT_FOUNDDatabase service with given ID or FQN does not exist