Skip to main content
DELETE
DELETE /v1/glossaries/{id}

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}

Returns

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

Error Handling