Sessions

Create a connect session

Mints a short-lived (24h) session for one domain and the DNS records the end user must create, and returns the hosted connectUrl plus the fully-qualified names verification will look up. Hosts are composed relative to the session's domain — read records[].fqdn in the response to confirm what will actually be checked. An OAuth caller is team-scoped and must send appId; a secret-key caller's app is implicit in the key and a mismatching appId is rejected.

post/api/v1/sessions

Request

  • Base URL: https://app.dodomain.io
  • URL: https://app.dodomain.io/api/v1/sessions
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.dodomain.io/api/auth/oauth2/authorize, token URL https://app.dodomain.io/api/auth/oauth2/token, scopes: sessions:write)

Headers

DoDomain-Teamstring

The id of the team this call acts on, from GET /api/v1/teams. Needed only when the credential can use more than one team (an OAuth connection granted several); a secret key has exactly one. A team the credential cannot use is refused 404 TEAM_NOT_FOUND — the same answer whether the team exists or not.

Request body

appIdstring
domainstring required
recipestring
returnUrlstring uri

Response

Success.

connectUrlstring required
expiresAtstring date-time required
idstring required
tokenstring required

Changes

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