Skip to main content

​
Overview

Every App gets a default URL at {slug}.mxp.co. You can also serve it on your own subdomain — for example, search.yourcompany.com — by adding a custom domain and creating a DNS CNAME record.

​
Add a custom domain

1

Open the Domains panel

In the App details page, click the Domains tab.
2

Enter your subdomain

Type the subdomain you want to use (e.g. search.yourcompany.com) and click Add Domain.
3

Add a DNS TXT record for verification

Add a TXT record to prove domain ownership. The record name and value are returned in the API response:
TypeNameValue
TXT_mixpeek-verify.search.yourcompany.commixpeek-site-verification={verification_token}
4

Create a CNAME record

In your DNS provider, add a CNAME record pointing your subdomain to the cname_target returned by the API:
TypeNameValue
CNAMEsearch.yourcompany.com{app_id}.apps.mixpeek.com
5

Trigger verification

Call POST /v1/apps/{app_id}/domains/{domain}/verify to start DNS polling. Mixpeek polls every 30 minutes for up to 72 hours, then provisions a TLS certificate automatically via Cloudflare.Domain status changes to active once the certificate is issued.

​
Domain statuses

StatusMeaning
pendingDomain added, waiting for DNS verification
verifyingTXT record found, polling for CNAME propagation
provisioning_tlsCNAME verified, issuing TLS certificate
activeDomain is live and serving HTTPS
failedVerification failed after 72 hours — check your DNS records

​
Via API

from mixpeek import Mixpeek

client = Mixpeek(api_key="your-api-key", namespace_id="ns_...")

domain = client.apps.domains.add(
    app_id="app_...",
    domain="search.yourcompany.com",
)
print(domain.status)  # "pending"

​
Notes

  • Only subdomain CNAMEs are supported (not apex/root domains).
  • Each domain can be attached to one App at a time.
  • Removing a domain does not affect the App’s default {slug}.mxp.co URL.