Deploys.app Docs

Domains

A domain represents a custom hostname (or wildcard) you own. Attach it to a project + location, prove ownership with DNS, and the platform terminates TLS and routes traffic for you.

The Domains page#

The Domains tab in the console lists every custom domain in the project, with its wildcard flag, CDN flag, and the location it’s bound to.

console.deploys.app/domain?project=acme
Domain list: apex, www, api, and a wildcardDomain list: apex, www, api, and a wildcard
Four domains in the same project — a mix of apex, subdomains, CDN on and off, and a wildcard.

Create a domain#

You’ll set four things:

  • Domain — the hostname, e.g. acme.example.com or acme.dev (apex).
  • Location — the cluster the domain will serve from. The hostname’s TLS certificate is provisioned in this location.
  • Wildcard — if true, the domain covers *.host as well as host.
  • CDN — if true, traffic goes through the CDN edge before reaching the origin. Recommended for public-facing apps.
curl https://api.deploys.app/domain.create \
  -H "Authorization: Bearer $DEPLOYS_TOKEN" \
  -d '{
    "project": "acme",
    "location": "gke.cluster-rcf2",
    "domain": "acme.example.com",
    "wildcard": false,
    "cdn": true
  }'

The domain is created in a pending state. To turn it active, you need to verify ownership.

Verify ownership#

After creating the domain, the console shows the DNS records you need to add at your registrar:

  • A TXT record at _deploys.<your-domain> containing the verification string. This proves you own the domain.
  • A CNAME (or A/AAAA records) pointing your domain at the location’s ingress. The console shows the exact targets for your location — typically a *.deploys.app CNAME plus IPv4/IPv6 addresses as a fallback.

Once those records propagate, the platform:

  1. Reads the TXT record and marks the domain verified.
  2. Provisions a TLS certificate (Let’s Encrypt) using HTTP-01 or DNS-01 — the console shows the relevant DCV record while it’s in progress.
  3. Flips the domain to active and starts accepting traffic.
NoteWildcard domains require DNS-01 verification, so you’ll also need to add a _acme-challenge.<host> CNAME the console shows you. Apex domains usually verify with HTTP-01 and don’t need that record.

Routing traffic#

Creating a domain alone doesn’t send any traffic to a deployment — you still need a route that maps (domain, path) to a deployment.

curl https://api.deploys.app/route.create \
  -d '{ "project": "acme", "location": "gke.cluster-rcf2",
        "domain": "acme.example.com", "path": "/", "deployment": "web" }'

The CDN#

When CDN is on, the platform fronts the domain with an edge cache. You get:

  • Global PoP routing — TLS terminates at the closest edge to the user.
  • Static asset caching with sensible defaults (respects standard Cache-Control).
  • DDoS mitigation and request filtering.

Two operations matter day to day:

  • Purge cache — invalidate cached content for the domain. Available from the console and as domain.purgeCache in the API.
  • Downgrade — turn CDN off. There’s a dedicated console flow at /domain/cdn-downgrade because it changes the routing path.
curl https://api.deploys.app/domain.purgeCache \
  -d '{ "project": "acme", "location": "gke.cluster-rcf2",
        "domain": "acme.example.com" }'

Removing a domain#

Deleting a domain also deletes any routes that reference it. The TLS certificate is revoked and the platform stops accepting traffic. Existing DNS records will just stop resolving to anything.

curl https://api.deploys.app/domain.delete \
  -H "Authorization: Bearer $DEPLOYS_TOKEN" \
  -d '{ "project": "acme", "location": "gke.cluster-rcf2",
        "domain": "acme.example.com" }'
NoteDomains are managed from the console and the API. The deploys CLI doesn’t currently include a domain namespace — use the API or the console.
On this page