Skip to main content
DELETE
/
v1
/
dataProducts
/
{id}
DELETE /v1/dataProducts/{id}
from metadata.sdk import configure
from metadata.sdk.entities import DataProducts

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

# Soft delete by ID
DataProducts.delete("b1839f98-f046-5f35-bdef-20f9b3395cb2")

# Hard delete
DataProducts.delete(
    "b1839f98-f046-5f35-bdef-20f9b3395cb2",
    hard_delete=True
)

# Delete by name
DataProducts.delete_by_name("Marketing.CustomerInsights")

# Restore a soft-deleted data product
DataProducts.restore("b1839f98-f046-5f35-bdef-20f9b3395cb2")

{
  "id": "b1839f98-f046-5f35-bdef-20f9b3395cb2",
  "name": "CustomerInsights",
  "fullyQualifiedName": "Marketing.CustomerInsights",
  "description": "Curated customer analytics data product",
  "version": 0.2,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "domain": {
    "id": "a0729e98-e946-4e25-acde-10e8a2294ba1",
    "type": "domain",
    "name": "Marketing",
    "fullyQualifiedName": "Marketing"
  },
  "deleted": true,
  "owners": [],
  "experts": []
}

Documentation Index

Fetch the complete documentation index at: https://docs.getcollate.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Delete a Data Product

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

​
Delete by ID

​
id
string
required
UUID of the data product to delete.
​
recursive
boolean
default:"false"
Recursively delete child entities.
​
hardDelete
boolean
default:"false"
Permanently delete the data product. If false, the data product is soft-deleted and can be restored.

​
Delete by Name

Use DELETE /v1/dataProducts/name/{fqn} to delete by fully qualified name.
​
fqn
string
required
Fully qualified name of the data product (e.g., Marketing.CustomerInsights).
​
recursive
boolean
default:"false"
Recursively delete child entities.
​
hardDelete
boolean
default:"false"
Permanently delete the data product.

​
Restore a Soft-Deleted Data Product

Use PUT /v1/dataProducts/restore to restore a soft-deleted data product.
​
id
string
required
UUID of the soft-deleted data product to restore.
DELETE /v1/dataProducts/{id}
from metadata.sdk import configure
from metadata.sdk.entities import DataProducts

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

# Soft delete by ID
DataProducts.delete("b1839f98-f046-5f35-bdef-20f9b3395cb2")

# Hard delete
DataProducts.delete(
    "b1839f98-f046-5f35-bdef-20f9b3395cb2",
    hard_delete=True
)

# Delete by name
DataProducts.delete_by_name("Marketing.CustomerInsights")

# Restore a soft-deleted data product
DataProducts.restore("b1839f98-f046-5f35-bdef-20f9b3395cb2")

{
  "id": "b1839f98-f046-5f35-bdef-20f9b3395cb2",
  "name": "CustomerInsights",
  "fullyQualifiedName": "Marketing.CustomerInsights",
  "description": "Curated customer analytics data product",
  "version": 0.2,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "domain": {
    "id": "a0729e98-e946-4e25-acde-10e8a2294ba1",
    "type": "domain",
    "name": "Marketing",
    "fullyQualifiedName": "Marketing"
  },
  "deleted": true,
  "owners": [],
  "experts": []
}

​
Returns

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

​
Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to delete this data product
404NOT_FOUNDData product with given ID or FQN does not exist