MImixpeek
Apps

Add a custom domain

Changed on

Attach a custom domain to an App.

Returns a verification_token and cname_target. To prove ownership, add a DNS TXT record:

_mixpeek-verify.{domain}  TXT  "mixpeek-site-verification={verification_token}"

Then call POST /{app_id}/domains/{domain}/verify to start polling.

post/v1/apps/{app_id}/domains

Request

  • Base URL
    https://api.mixpeek.com
  • Auth
    HTTP bearer

Path parameters

app_idstring required

App ID (e.g. app_abc123def456)

Request body

domainstring required

Customer domain (e.g. 'search.acme.com')

is_primaryboolean

Set as primary domain

Response

The newly added domain configuration

domainstring required
statusstring required
verification_tokenstring nullable
cname_targetstring nullable
is_primaryboolean required
verified_atstring nullable

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth was added to the API