CLICommand referencedomain

domain

Commands, arguments, and options for synq domain.

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

synq domain

Manage custom domains, DNS verification, and SSL certificates

synq domain [options] [command]
SubcommandPurpose
list [options]List a project's custom domains
add [options] <hostname>Add a custom domain to a project
preview <hostname>Preview the DNS records a hostname would need (no changes saved)
verify <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-allRenew SSL for every near-expiry domain in your organization

synq domain add

Add a custom domain to a project

synq domain add [options] <hostname>
ArgumentMeaning
hostnameDomain hostname (e.g. app.example.com)
OptionMeaning
-p, --project <id>Project ID to attach the domain to
--primaryMark this domain as the project's primary (default: false)

synq domain list

List a project's custom domains

synq domain list [options]
OptionMeaning
-p, --project <id>Project ID to list domains for

synq domain preview

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

synq domain preview [options] <hostname>
ArgumentMeaning
hostnameDomain hostname to preview

synq domain primary

Make a domain the project's primary hostname

synq domain primary [options] <id>
ArgumentMeaning
idDomain ID

synq domain records

Show the DNS records for an existing domain

synq domain records [options] <id>
ArgumentMeaning
idDomain ID

synq domain renew

Renew the SSL certificate for a domain

synq domain renew [options] <id>
ArgumentMeaning
idDomain ID

synq domain renew-all

Renew SSL for every near-expiry domain in your organization

synq domain renew-all [options]

synq domain verify

Run DNS verification for a domain

synq domain verify [options] <id>
ArgumentMeaning
idDomain ID

synq domain verify-ssl

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

synq domain verify-ssl [options] <id>
ArgumentMeaning
idDomain ID

On this page