Skip to main content
POST
Create Domain Connect URL
Use the returned URL to authorize DNS changes at the subdomain’s DNS provider. Start a local HTTP listener at http://127.0.0.1:{port}/domain-connect/callback and send its port in the request body. Keep the listener running while you open the URL and complete authorization in your browser. Remote sessions require port forwarding so your browser can reach the listener. The URL is specific to that callback listener and isn’t stored on the subdomain. The dns_provider display name is optional and may be omitted from the response. This endpoint returns 409 if Domain Connect is unavailable for this subdomain or it is no longer awaiting DNS validation. A public pending status doesn’t guarantee availability: DNS may already be validated while certificate issuance is still in progress. If Domain Connect is unavailable, add the DNS records manually. Authorization doesn’t mean the subdomain is ready to use. Call Verify subdomain, then poll Get subdomain (GET /subdomains/{id}) until the status is active before updating your application’s endpoints. Respect the verification rate limit.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Version
string
required

Management API version.

Path Parameters

id
string
required

Body

application/json
port
integer
required

Local loopback port where the CLI is listening for the Domain Connect callback.

Required range: 1 <= x <= 65535
Example:

8976

Response

Signed Domain Connect URL.

data
object
required