CustomDomain™ docs
Cloud browser

A link the end user opens to renew the domain's lasting API key

A link the end user opens to renew the domain's lasting API key: CustomDomain™ API reference. Covers parameters, request body, responses and error codes.

POST
/connections/{id}:reconnect-link

For a connection whose records were written with a lasting API key the cloud browser's agent made at the DNS provider. The link opens the hosted connect page in reconnect mode, straight on the sign in for that provider: after the end user signs in, the agent makes a new key with the same scopes, checks it and swaps it in, and no DNS record changes. It is a shared flow link (/connect/{token}): it works once and expires after 14 days.

With send: true and the end user's email address on the connection (and the end user email feature on), CustomDomain™ emails the link on the application's behalf and the answer is emailed: true with no link; otherwise the answer carries the link to pass on. The control plane also emails one by itself 30 and 7 days before the key's end and when the provider stops accepting it. A connection with no such key answers 409 not_reconnectable. A delegated agent token needs domains:connect.

Authorization

AuthorizationBearer <token>

Short-lived widget JWT minted server-side via POST /v1/tokens. Scoped to one application (and optionally one domain).

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/connections/string:reconnect-link" \  -H "Content-Type: application/json" \  -d '{}'
{  "link": "http://example.com",  "emailed": true}
{  "code": "string",  "title": "string",  "details": "string"}
{  "code": "string",  "title": "string",  "details": "string"}
{  "code": "string",  "title": "string",  "details": "string"}
{  "code": "string",  "title": "string",  "details": "string"}