Custom domains

Serve every API of a project on your own domain, such as api.yourapp.com, with certificates issued and renewed for you. Included from the Pro plan.

A custom domain serves every API of your project (REST, Auth, Storage, Realtime and Edge Functions) on a name you own, such as api.yourapp.com, instead of <ref>.p.stitchdb.com. Certificates are issued and renewed for you, there is no extra charge on paid plans, and the domain follows your project when it moves, fails over or serves reads from a replica close to your users.

#Add a domain

1. Open Project › Settings › Custom domains, enter the domain and click Add domain.
2. At your DNS provider, add the CNAME record shown on the page: the name (such as api) pointing to <ref>.p.stitchdb.com. If your provider offers a proxy or CDN for the record, keep it off (DNS only), otherwise the certificate can’t be issued.
3. Within a few minutes of the record showing up, the domain is checked, a certificate is issued and the status turns Live. Click Check now to skip the wait.

#Use it in your app

Use the domain as the project URL. The keys stay the same, and the project’s own address keeps working.

import { createClient } from 'stitchdb-js'

const stitchdb = createClient('https://api.yourapp.com', STITCHDB_ANON_KEY)

#Use it for Auth

Tick Use for Auth on a live domain and e-mail links, OAuth callbacks, SAML and the token issuer move to https://api.yourapp.com/auth/v1, so users only ever see your domain. Before you turn it on, add https://api.yourapp.com/auth/v1/callback as a redirect URI at each OAuth provider you use (Google, GitHub …). Auth restarts once, which takes a few seconds. Only one domain per project can be used for Auth.

#Use it for the status page

Tick Use for the status page on a live domain such as status.yourapp.com and its root opens your project's status page; links in status e-mails and webhooks use it too. Every API keeps working on the same domain. One domain at a time can show the status page.

#Status

#How it works

The CNAME makes your domain resolve like <ref>.p.stitchdb.com, which StitchDB’s own DNS answers with the servers of your project. The certificate is proven over HTTP on port 80 of those servers and installed on each of them; requests are handled exactly like requests to the project’s own address, with the same limits, logs and usage. Nothing is proxied through a third party.

#Limits