domain

See the workflow guide for examples. Global flags such as --json go before the command; see global options.

openship domain

Manage custom domains, DNS verification, and SSL certificates

openship domain [options] [command]

Subcommand	Purpose
`list [options]`	List a project's custom domains
`add [options] <hostname>`	Add a custom domain and route it on the next deploy
`preview <hostname>`	Preview the DNS records a hostname would need (no changes saved)
`verify [options] <id>`	Run DNS verification for a domain
`primary <id>`	Make a domain the project's primary hostname
`records <id>`	Show the DNS records for an existing domain
`renew <id>`	Renew the SSL certificate for a domain
`verify-ssl <id>`	Recheck that a domain's SSL certificate is issued and valid (no reissue)
`renew-all`	Renew SSL for every near-expiry domain in your organization
`dns`	Plan and apply provider-managed DNS records
`get <id>`	Show a domain and its routing configuration
`remove\|rm [options] <id>`	Remove a domain and its managed route
`upload-cert [options] <id>`	Install a manual certificate through the shared hostname and key validation
`verify-pending [options]`	Retry eligible pending domains within the selected organization

Add a custom domain and route it on the next deploy

openship domain add [options] <hostname>

Argument	Meaning
`hostname`	Domain hostname (e.g. app.example.com)

Option	Meaning
`-p, --project <id>`	Project ID to attach the domain to
`--primary`	Mark this domain as the project's primary (default: false)

Show a domain and its routing configuration

openship domain get [options] <id>

Argument	Meaning
`id`	Domain ID

List a project's custom domains

openship domain list [options]

Option	Meaning
`-p, --project <id>`	Project ID to list domains for

Preview the DNS records a hostname would need (no changes saved)

openship domain preview [options] <hostname>

Argument	Meaning
`hostname`	Domain hostname to preview

Make a domain the project's primary hostname

openship domain primary [options] <id>

Argument	Meaning
`id`	Domain ID

Show the DNS records for an existing domain

openship domain records [options] <id>

Argument	Meaning
`id`	Domain ID

Remove a domain and its managed route

openship domain remove|rm [options] <id>

Argument	Meaning
`id`	Domain ID

Option	Meaning
`-y, --yes`	Skip confirmation

Renew the SSL certificate for a domain

openship domain renew [options] <id>

Argument	Meaning
`id`	Domain ID

Renew SSL for every near-expiry domain in your organization

openship domain renew-all [options]

Install a manual certificate through the shared hostname and key validation

openship domain upload-cert [options] <id>

Argument	Meaning
`id`	Domain ID

Option	Meaning
`--cert <file>`	PEM certificate chain file
`--key <file>`	PEM private key file

Run DNS verification for a domain

openship domain verify [options] <id>

Argument	Meaning
`id`	Domain ID

Option	Meaning
`--force`	Recheck an already-verified hostname
`--follow`	Stream DNS and certificate progress
`--timeout <ms>`	Stop following after this deadline

Retry eligible pending domains within the selected organization

openship domain verify-pending [options]

Option	Meaning
`--limit <number>`	Maximum domains to inspect
`--min-age <minutes>`	Minimum pending age in minutes

Recheck that a domain's SSL certificate is issued and valid (no reissue)

openship domain verify-ssl [options] <id>

Argument	Meaning
`id`	Domain ID