Skip to main content
DELETE
Delete a domain
Detach one custom domain from the API key’s workspace. Requires Custom domains: Write (custom_domains.delete).
Links are not deleted. Links in this workspace that used the custom domain are moved to Biqli’s default short domain, so their short URLs change.

Response

Deletion returns 200 OK because the summary matters:
If this was the last attachment, domain_deleted is true and Biqli queues the domain cleanup workflow. Other workspaces are never detached by this call. A repeated call returns 404 resource_not_found. Malformed and cross-workspace IDs return that same response. This endpoint accepts one public ID only, not a host, numeric ID, or comma-separated list.

Shared API behavior

Authentication is workspace-scoped; see Authentication. Errors use the standard envelope and request IDs described in Errors, and requests are subject to Rate limits.

Authorizations

Authorization
string
header
required

A workspace API key beginning with biqli_.

Path Parameters

domain
string
required

Public custom-domain ID. Numeric IDs and hosts are not accepted.

Pattern: ^biq_dom_[0-9A-HJKMNP-TV-Z]{26}$

Response

Domain detached successfully.

id
string
required
Pattern: ^biq_dom_[0-9A-HJKMNP-TV-Z]{26}$
detached
boolean
required
domain_deleted
boolean
required
Required range: x >= 0
remaining_attachments
integer
required
Required range: x >= 0
status
string
required
Allowed value: "success"