Cloud browser

Begin the cloud browser sign in for a connection

Customer present only. For a DNS provider with no sign in of its own, the customer signs in to the provider inside a temporary browser that a browser hosting company runs for a few minutes. They type their own username, password and any verification code into the provider's real sign in page, so CustomDomain™ never receives them, and nothing is stored. Our software then reads the provider's DNS page for this one domain, shows the customer the exact changes, and makes them only after the customer approves. It never creates an API key at the provider, and a session never runs without the customer present.

Returns the address of the popup page that shows the browser. Its fragment carries a single use bootstrap code, which no server sees; the popup trades it at POST /browser-sessions:redeem. Only an end user's widget token (bound to the domain and to the end user) or the console may start one: an agent, the MCP server and a plain API key are refused with browser_customer_present_only. The request must carry an Origin header on the server's return origin allowlist. A browser sends one (the widget and the popup do), and the console's server must add it to the call it makes for a customer. A request with no Origin at all, such as a server to server call, is refused with browser_customer_present_only and a message that says the header is missing; an Origin that is not on the list is refused the same way.

A record set an integrator supplied, and any type or value the provider's page cannot write, is refused before the customer signs in (browser_unsupported_records, with the types named). The rail is offered only for a provider that has no sign in of its own, and only while the deployment has it on (rails.cloud_browser on the domain check).

post/connections/{id}/browser:start

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/connections/{id}/browser:start
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring required

Request body

providerstring required

DNS provider id; defaults to the detected provider.

return_originstring required

Web origin the popup posts its result to; must be on the server's allowlist.

consent_versionstring required

The id of the consent text the customer was shown, stored with the session.

localestring

The language the popup reads in, a plain code such as en. Defaults to en.

Response

The session was created.

session_idstring required

The session id, bs_ and 32 hex characters.

open_urlstring uri required

The popup page, with #c=<bootstrap code>&l=<locale> in its fragment.

vendorstring required

The browser hosting company, shown to the customer.

expires_atstring date-time required

The latest the session can end.

Changes

No recorded changes to this operation across all 1 revision of this API.