Skip to main content
DELETE
https://sandbox.getcollate.io/api
/
v1
/
glossaries
/
{id}
DELETE /v1/glossaries/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Glossaries

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

# Soft delete by ID
Glossaries.delete("c2940a98-f147-6g46-cdef-31f0c4406dc3")

# Hard delete
Glossaries.delete(
    "c2940a98-f147-6g46-cdef-31f0c4406dc3",
    hard_delete=True
)

# Delete by name
Glossaries.delete_by_name("BusinessGlossary")

# Restore a soft-deleted glossary
Glossaries.restore("c2940a98-f147-6g46-cdef-31f0c4406dc3")

{
  "id": "c2940a98-f147-6g46-cdef-31f0c4406dc3",
  "name": "BusinessGlossary",
  "fullyQualifiedName": "BusinessGlossary",
  "description": "Standard business terminology for the organization",
  "version": 0.2,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "deleted": true,
  "owners": [],
  "reviewers": [],
  "tags": [],
  "mutuallyExclusive": false
}

​
Delete a Glossary

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

​
Delete by ID

​
id
string
required
UUID of the glossary to delete.
​
recursive
boolean
default:"false"
Recursively delete all glossary terms within this glossary.
​
hardDelete
boolean
default:"false"
Permanently delete the glossary. If false, the glossary is soft-deleted and can be restored.

​
Delete by Name

Use DELETE /v1/glossaries/name/{fqn} to delete by fully qualified name.
​
fqn
string
required
Fully qualified name of the glossary (e.g., BusinessGlossary).
​
recursive
boolean
default:"false"
Recursively delete all glossary terms.
​
hardDelete
boolean
default:"false"
Permanently delete the glossary.

​
Restore a Soft-Deleted Glossary

Use PUT /v1/glossaries/restore to restore a soft-deleted glossary.
​
id
string
required
UUID of the soft-deleted glossary to restore.
DELETE /v1/glossaries/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Glossaries

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

# Soft delete by ID
Glossaries.delete("c2940a98-f147-6g46-cdef-31f0c4406dc3")

# Hard delete
Glossaries.delete(
    "c2940a98-f147-6g46-cdef-31f0c4406dc3",
    hard_delete=True
)

# Delete by name
Glossaries.delete_by_name("BusinessGlossary")

# Restore a soft-deleted glossary
Glossaries.restore("c2940a98-f147-6g46-cdef-31f0c4406dc3")

{
  "id": "c2940a98-f147-6g46-cdef-31f0c4406dc3",
  "name": "BusinessGlossary",
  "fullyQualifiedName": "BusinessGlossary",
  "description": "Standard business terminology for the organization",
  "version": 0.2,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "deleted": true,
  "owners": [],
  "reviewers": [],
  "tags": [],
  "mutuallyExclusive": false
}

​
Returns

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

​
Error Handling

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