Domains

Preflight a domain before adding it

Canonicalizes the hostname and returns an advisory hostability verdict. A negative verdict usually means the domain is already in use with another host — it can still be added and claimed with a TXT ownership proof, so treat the verdict as a warning, not a block.

get/v1/domains/preflight

Request

  • Base URL: https://api.spacefast.com
  • URL: https://api.spacefast.com/v1/domains/preflight
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.spacefast.com/v1/auth/oauth2/authorize, token URL https://api.spacefast.com/v1/auth/oauth2/token; client credentials, token URL https://api.spacefast.com/v1/auth/oauth2/token, scopes: domains:write)

Query parameters

namestring required

Apex or concrete hostname to preflight; canonicalized server-side.

teamIdstring

Team the domain would be added to. Defaults the same way POST /v1/domains does.

Response

Response for status 200

$schemastring uri

Canonical JSON Schema URL for this response body. The server also sends it in the Link: rel="describedby" response header.

Changes

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