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

{
  "webDomain": "verify.example.com",
  "oidcDomain": "connect.example.com",
  "status": "awaiting_dns",
  "requiredAction": "add_cname",
  "statusMessage": "Add the DNS records below, then verify.",
  "dnsRecords": [
    {
      "id": "web-cname",
      "type": "CNAME",
      "host": "verify.example.com",
      "name": "verify.example.com",
      "value": "cname.hopae-edge.com",
      "required": true,
      "description": "Routes your Web Frontend host to the Hopae edge."
    },
    {
      "id": "oidc-cname",
      "type": "CNAME",
      "host": "connect.example.com",
      "name": "connect.example.com",
      "value": "cname.hopae-edge.com",
      "required": true,
      "description": "Routes your OIDC Backend host to the Hopae edge."
    },
    {
      "id": "web-ownership",
      "type": "TXT",
      "host": "verify.example.com",
      "name": "_hopae-verify.verify.example.com",
      "value": "hopae-domain-verification=2b9f8e1c4a7d",
      "required": true,
      "description": "Proves you control the domain."
    },
    {
      "id": "web-dcv",
      "type": "CNAME",
      "host": "verify.example.com",
      "name": "_acme-challenge.verify.example.com",
      "value": "verify.example.com.5f2a9c.dcv.hopae.com",
      "required": true,
      "description": "Domain Control Validation for SSL certificate issuance."
    },
    {
      "id": "oidc-dcv",
      "type": "CNAME",
      "host": "connect.example.com",
      "name": "_acme-challenge.connect.example.com",
      "value": "connect.example.com.8d1b3e.dcv.hopae.com",
      "required": true,
      "description": "Domain Control Validation for SSL certificate issuance."
    }
  ],
  "lastCheckedAt": "2026-06-18T01:12:48.000Z"
}
Returns the current custom domain state for an app, including the configured hosts, status, required action, and the DNS records to add. See Custom Domain for the concept and lifecycle.
This endpoint is read-only. It returns the stored state but does not trigger verification or advance the status. To re-check DNS/SSL and move the status forward, call Verify Custom Domain.

​
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 a CustomDomainStateDto.
​
webDomain
string
The configured Web Frontend host (serves the hosted verification UI). Omitted when unconfigured.
​
oidcDomain
string
The configured OIDC Backend host (serves the OIDC endpoints). Omitted when unconfigured.
​
status
string
Lifecycle status. One of unconfigured, awaiting_dns, verifying, active, invalid. See Custom Domain for the lifecycle.
​
requiredAction
string
What you need to do next. One of none, add_cname, waiting, verify, contact_support, retry.
​
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. Add every required record for both hosts before verifying.
​
lastCheckedAt
string
ISO 8601 timestamp of the most recent verify. Omitted until the first verify runs.
curl -H "Authorization: Bearer sk_workspace_test_..." \
  "https://sandbox.api.hopae.com/connect/v1/apps/abc123/custom-domain"

{
  "webDomain": "verify.example.com",
  "oidcDomain": "connect.example.com",
  "status": "awaiting_dns",
  "requiredAction": "add_cname",
  "statusMessage": "Add the DNS records below, then verify.",
  "dnsRecords": [
    {
      "id": "web-cname",
      "type": "CNAME",
      "host": "verify.example.com",
      "name": "verify.example.com",
      "value": "cname.hopae-edge.com",
      "required": true,
      "description": "Routes your Web Frontend host to the Hopae edge."
    },
    {
      "id": "oidc-cname",
      "type": "CNAME",
      "host": "connect.example.com",
      "name": "connect.example.com",
      "value": "cname.hopae-edge.com",
      "required": true,
      "description": "Routes your OIDC Backend host to the Hopae edge."
    },
    {
      "id": "web-ownership",
      "type": "TXT",
      "host": "verify.example.com",
      "name": "_hopae-verify.verify.example.com",
      "value": "hopae-domain-verification=2b9f8e1c4a7d",
      "required": true,
      "description": "Proves you control the domain."
    },
    {
      "id": "web-dcv",
      "type": "CNAME",
      "host": "verify.example.com",
      "name": "_acme-challenge.verify.example.com",
      "value": "verify.example.com.5f2a9c.dcv.hopae.com",
      "required": true,
      "description": "Domain Control Validation for SSL certificate issuance."
    },
    {
      "id": "oidc-dcv",
      "type": "CNAME",
      "host": "connect.example.com",
      "name": "_acme-challenge.connect.example.com",
      "value": "connect.example.com.8d1b3e.dcv.hopae.com",
      "required": true,
      "description": "Domain Control Validation for SSL certificate issuance."
    }
  ],
  "lastCheckedAt": "2026-06-18T01:12:48.000Z"
}