Delete a Test Suite

Delete a test suite by ID or name, with soft/hard delete options

DELETE /v1/dataQuality/testSuites/{id}

DELETE /v1/dataQuality/testSuites/{id}

Python

from metadata.sdk import configure
from metadata.sdk.entities import TestSuites

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Soft delete by ID
TestSuites.delete("e86a9a11-852f-4bac-b5a7-993b2bbbb572")

# Hard delete
TestSuites.delete(
    "e86a9a11-852f-4bac-b5a7-993b2bbbb572",
    hard_delete=True
)

# Delete by name
TestSuites.delete_by_name("b5fcae09-02c2-4c0b-8c4a-5b52d650e592")

# Restore a soft-deleted test suite
TestSuites.restore("e86a9a11-852f-4bac-b5a7-993b2bbbb572")

Response (Soft Delete)

{
  "id": "e86a9a11-852f-4bac-b5a7-993b2bbbb572",
  "name": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
  "displayName": "Data Contract - dim_address_comprehensive_contract",
  "fullyQualifiedName": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
  "version": 0.2,
  "updatedAt": 1769982800000,
  "updatedBy": "admin",
  "deleted": true,
  "owners": [],
  "executable": true
}

Delete a Test Suite

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

Delete by ID

id · string · required

UUID of the test suite to delete.

recursive · boolean · default: "false"

Recursively delete child entities (test cases within the suite).

hardDelete · boolean · default: "false"

Permanently delete the test suite. If false, the test suite is soft-deleted and can be restored.

Delete by Name

Use DELETE /v1/dataQuality/testSuites/name/{fqn} to delete by fully qualified name.

fqn · string · required

Fully qualified name of the test suite.

recursive · boolean · default: "false"

Recursively delete child entities.

hardDelete · boolean · default: "false"

Permanently delete the test suite.

Restore a Soft-Deleted Test Suite

Use PUT /v1/dataQuality/testSuites/restore to restore a soft-deleted test suite.

id · string · required

UUID of the soft-deleted test suite to restore.

DELETE /v1/dataQuality/testSuites/{id}

Python

from metadata.sdk import configure
from metadata.sdk.entities import TestSuites

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Soft delete by ID
TestSuites.delete("e86a9a11-852f-4bac-b5a7-993b2bbbb572")

# Hard delete
TestSuites.delete(
    "e86a9a11-852f-4bac-b5a7-993b2bbbb572",
    hard_delete=True
)

# Delete by name
TestSuites.delete_by_name("b5fcae09-02c2-4c0b-8c4a-5b52d650e592")

# Restore a soft-deleted test suite
TestSuites.restore("e86a9a11-852f-4bac-b5a7-993b2bbbb572")

Response (Soft Delete)

{
  "id": "e86a9a11-852f-4bac-b5a7-993b2bbbb572",
  "name": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
  "displayName": "Data Contract - dim_address_comprehensive_contract",
  "fullyQualifiedName": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
  "version": 0.2,
  "updatedAt": 1769982800000,
  "updatedBy": "admin",
  "deleted": true,
  "owners": [],
  "executable": true
}

---

Returns

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

---

Error Handling

Code	Error Type	Description
401	UNAUTHORIZED	Invalid or missing authentication token
403	FORBIDDEN	User lacks permission to delete this test suite
404	NOT_FOUND	Test suite with given ID or FQN does not exist