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

Delete a Domain

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

Delete by ID

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

Delete by Name

Use DELETE /v1/domains/name/{fqn} to delete by fully qualified name.
fqn
string
required
Fully qualified name of the domain (e.g., TestDomain).
recursive
boolean
default:"false"
Recursively delete child domains.
hardDelete
boolean
default:"false"
Permanently delete the domain.

Restore a Soft-Deleted Domain

Use PUT /v1/domains/restore to restore a soft-deleted domain.
id
string
required
UUID of the soft-deleted domain to restore.
DELETE /v1/domains/{id}

Returns

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

Error Handling