Domains
A domain gives your deployment a permanent, human-readable address.
Available via Web, CLI, SDK, MCP, and API.
Types
There are two kinds of domains on the platform:
Platform domains
Subdomains of shipstatic.com, like my-app.shipstatic.com.
- Created instantly, no DNS configuration needed
- Automatically verified and live as soon as they're linked to a deployment
- Available on all plans
- Name must be at least 6 characters
Custom domains
Your own domain, like www.example.com or blog.example.com.
- Requires DNS records pointing to the platform
- Must be a subdomain — apex domains (
example.com) are not hosted directly - For
wwwsubdomains, an A record redirects apex traffic towww - Available on paid plans
- SSL is provisioned automatically after DNS verification
Properties
| Property | Description |
|---|---|
domain |
Fully qualified domain name |
deployment |
Linked deployment ID, or null if reserved |
status |
DNS verification state (see below) |
labels |
Mutable tags for organization |
verified |
When DNS was last verified |
created |
Creation timestamp |
DNS Verification
Platform domains are verified instantly. Custom domains require DNS verification:
| Status | Meaning |
|---|---|
pending |
No DNS records verified yet |
partial |
Some records found (e.g. CNAME but not A) |
success |
All records verified - domain is live |
paused |
The plan no longer entitles this domain (e.g. paid plan downgraded) — DNS is preserved but the domain stops serving. Resumes automatically on re-upgrade |
Required DNS Records
www subdomain (e.g. www.example.com):
| Type | Name | Purpose |
|---|---|---|
| CNAME | www |
Serves the site |
| A | @ |
Redirects example.com to www.example.com |
Other subdomains (e.g. blog.example.com):
| Type | Name | Purpose |
|---|---|---|
| CNAME | blog |
Serves the site |
The A record is infrastructure only - it redirects apex traffic. The CNAME is always the actual endpoint.
Wildcard CNAME
If you'd rather configure once and forget, point a wildcard *.example.com → cname.shipstatic.com at your DNS provider. Any subdomain you create on the platform under example.com will resolve through the wildcard without per-subdomain records.
Sharing DNS setup
Custom domain DNS often needs to be set up by a different person than the one running deploys (the domain owner, an IT admin, etc.). Each domain has a shareable hash you can hand off — the recipient sees the required DNS records without needing an API key.
Available via the share operation on CLI, SDK, MCP, and API. The result is a URL on my.shipstatic.com/connect/... showing exactly the records to add.
DNS provider lookup
The platform identifies your domain's DNS provider (Cloudflare, Namecheap, GoDaddy, etc.) so users can be guided to the right place to add records. Available via the dns operation.
Lifecycle
- Reserve - Create a domain without linking it to a deployment.
- Link - Point the domain to a deployment.
- Switch - Atomically repoint to a different deployment.
- Delete - Remove the domain entirely.
No unlinking. Once linked to a deployment, a domain cannot be set back to empty. Switch to a different deployment or delete the domain.
Normalization
Domain names are case-insensitive and Unicode-aware. The API normalizes all input - Example.COM becomes example.com.
Operations
| Operation | Description |
|---|---|
| Set | Create, link, switch, or label a domain (upsert) |
| List | All domains on your account |
| Get | Details of a specific domain |
| Remove | Delete a domain |
| Validate | Pre-flight check - is the name valid and available? |
| Verify | Trigger DNS verification |
| DNS | Required DNS records for setup |
| Records | Current live DNS records |
| Share | Shareable DNS setup link |