Skip to main content
DELETE
/
apps
/
{client_id}
/
custom-domain
curl -X DELETE \
  -H "Authorization: Bearer sk_workspace_test_..." \
  "https://sandbox.api.hopae.com/connect/v1/apps/abc123/custom-domain"

{
  "status": "unconfigured",
  "requiredAction": "none",
  "dnsRecords": []
}
Tears down the custom domain and reverts the app to the default Hopae URLs. Returns the resulting CustomDomainStateDto (now unconfigured). See Custom Domain for the concept and lifecycle.
This can be done at any status, including active. Deleting an active domain takes it out of service immediately — verification pages and the OIDC backend fall back to the default Hopae URLs at once, which breaks any integration still pointing at the custom hosts. This action can’t be undone.

​
Request

​
Authorization
string
required
Bearer <API_KEY> from Console > Developers > Workspace API Keys.

​
Path parameters

​
client_id
string
required
Client identifier of the app.

​
Response

Returns the CustomDomainStateDto after teardown — status is unconfigured and the host fields are cleared. After deletion you can safely remove the DNS records you added.
​
webDomain
string
The configured Web Frontend host. Cleared (omitted) after deletion.
​
oidcDomain
string
The configured OIDC Backend host. Cleared (omitted) after deletion.
​
status
string
Lifecycle status. unconfigured after a successful delete.
​
requiredAction
string
What you need to do next. One of none, add_cname, waiting, verify, contact_support, retry. none after a successful delete.
​
statusMessage
string
Human-readable explanation of the current status. Omitted when there is nothing to report.
​
dnsRecords
object[]
DNS records to add at your DNS provider. Empty after deletion. See Get Custom Domain for each record’s fields.
​
lastCheckedAt
string
ISO 8601 timestamp of the most recent verify. Omitted once unconfigured.
curl -X DELETE \
  -H "Authorization: Bearer sk_workspace_test_..." \
  "https://sandbox.api.hopae.com/connect/v1/apps/abc123/custom-domain"

{
  "status": "unconfigured",
  "requiredAction": "none",
  "dnsRecords": []
}