Domains
A domain gives your deployment a permanent, human-readable address.
Types
There are two kinds of domains on the platform:
Internal domains
Subdomains of shipstatic.dev, like my-app.shipstatic.dev.
- 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
Internal 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 |
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.
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 |