PgBeam Docs
projectsdomains

domains add

Add a custom domain

Register a custom domain for the linked project. After adding, PgBeam returns the DNS records (CNAME and TXT) you need to configure with your DNS provider to verify ownership. Once DNS records are in place, run pgbeam domains verify to complete verification and provision a TLS certificate.

Usage

pgbeam domains add [domain]

Options

OptionDescriptionRequiredDefault
<domain>The domain name to register (e.g. pg.example.com). If omitted, you will be prompted.No-

Global options

All global options (--token, --profile, --project, --org, --json, --no-color, --debug) are also available on this command.

Examples

# Add a domain interactively
pgbeam domains add

# Add a specific domain
pgbeam domains add pg.example.com

# Add a domain and get DNS instructions as JSON
pgbeam domains add pg.example.com --json

Output

Prints the domain name and the DNS records (CNAME and TXT) required for verification. Suggests running pgbeam domains verify <id> as the next step. With --json, returns the domain object including dns_instructions.

On this page