Custom Domains

A published project answers at <projectId>.totalum-project.com. On the Professional and Enterprise plans it also answers at <projectId>.webapp-project.com — both addresses serve the site — and Update Project { "liveHostSuffix": "webapp-project.com" } makes that one the main address (the one shown as productionProjectUrl and used for links). Add one custom domain per project: a subdomain (app.example.com) or a whole domain (example.com or www.example.com, served as www.example.com; the bare domain redirects to it once it points here, which needs an ALIAS/ANAME record or CNAME flattening at your DNS provider — otherwise add a URL redirect from example.com to https://www.example.com there). You create the DNS records at your DNS provider; SSL is issued automatically. A domain bought on Totalum is attached with its own endpoint and needs no DNS work.

An address without "totalum" in it. For a white-label app, use either option:

• webapp-project.com (Professional and Enterprise): set liveHostSuffix to "webapp-project.com", and the main address, links, sitemap and preview use <projectId>.webapp-project.com. The totalum-project.com address keeps working too, so old links never break; it just isn't shown anywhere.
• Your own domain (any paid plan): add a custom domain or buy one on Totalum. It becomes the published address.

Domains are set per project: each project can have its own custom domain and/or use webapp-project.com. One domain that replaces the address of every project of an account at once is not supported yet.

A custom domain costs 4 credits when added and 3 credits a month while active. Custom domains are included on paid plans.

curl -X PUT \
  -H "api-key: tlm_sk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"hostname":"book.barbershop.com"}' \
  https://builder-api.totalum.app/api/v1/vcaas/projects/barber-bookings/domain

const res = await fetch("https://builder-api.totalum.app/api/v1/vcaas/projects/barber-bookings/domain", {
  method: "PUT",
  headers: {
    "api-key": process.env.TOTALUM_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "hostname": "book.barbershop.com"
  }),
});
const { errors, data } = await res.json();

{
  "errors": null,
  "data": {
    "success": true,
    "hostname": "book.barbershop.com",
    "status": "pending",
    "dnsRecordsToAdd": [
      { "type": "CNAME", "name": "book.barbershop.com", "value": "barber-bookings.totalum-project.com" },
      { "type": "TXT", "name": "_cf-custom-hostname.book.barbershop.com", "value": "4f6a2c9e-…" }
    ]
  }
}

curl -H "api-key: tlm_sk_your_key" \
  https://builder-api.totalum.app/api/v1/vcaas/projects/barber-bookings/domain

const res = await fetch("https://builder-api.totalum.app/api/v1/vcaas/projects/barber-bookings/domain", {
  headers: {
    "api-key": process.env.TOTALUM_API_KEY,
  },
});
const { errors, data } = await res.json();

{ "errors": null, "data": { "hostname": "app.barbershop.io", "status": "active", "sslStatus": "active", "domain": "barbershop.io", "kind": "domain", "canonicalHost": "app", "source": "purchase", "accountDomainId": "dom_01k6y3", "hostnames": [{ "hostname": "app.barbershop.io", "role": "canonical", "status": "active", "sslStatus": "active", "dnsRecordsToAdd": [], "verificationErrors": [] }, { "hostname": "barbershop.io", "role": "alias", "status": "active", "sslStatus": "active", "dnsRecordsToAdd": [], "verificationErrors": [] }], "dnsRecordsToAdd": [], "redirects": { "canonical": "app.barbershop.io", "applyToDefaultHost": false, "rules": [] } } }

curl -X DELETE -H "api-key: tlm_sk_your_key" \
  https://builder-api.totalum.app/api/v1/vcaas/projects/barber-bookings/domain

const res = await fetch("https://builder-api.totalum.app/api/v1/vcaas/projects/barber-bookings/domain", {
  method: "DELETE",
  headers: {
    "api-key": process.env.TOTALUM_API_KEY,
  },
});
const { errors, data } = await res.json();

{ "errors": null, "data": { "success": true, "hostname": "book.barbershop.com", "message": "Custom domain removed" } }