sites

Attach domains

Serve a published Alpha website on a verified custom domain by domain id and any version id of the page (pageId). The page's live version is built again for the domain's own origin before the domain is attached, which can take a few minutes; calling it again moves the domain to the page's live version. The domain must also be added to Point11's hosting before its host answers.

post/api/v1/sites/domains/attach

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/sites/domains/attach
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Idempotency-Keystring uuid required

UUID naming this intent. Retry with the same key; reuse for other input is 409.

Request body

idstring required
pageIdstring required

Any version id of the published page; the domain serves its live version.

Response

Success.

idstring required
organizationIdstring required
domainstring required
verifiedboolean required
verificationTokenstring nullable required
verificationTokenExpiresAtstring date-time nullable required
sslStatus'pending' | 'active' | 'failed' required
siteConfigurationIdstring nullable required
pagePublicationIdstring nullable required

The published Alpha page publication this domain serves, or null.

pageArtifactIdstring nullable required

The page version the domain serves, built for its own origin; attach again to move it to the page's live version.

hostedAtstring date-time nullable required

When Point11 confirmed the domain is on its hosting; until then the page's own link stays its indexed address.

suspendedAtstring date-time nullable required

When Point11 suspended the domain; a suspended domain serves nothing.

createdAtstring date-time required
updatedAtstring date-time required

Changes

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