domain dns

read onlyrepeatableno sign-in

The DNS record a host needs before it can answer. It is worked out locally, so it needs no credential and answers before the domain is registered.

A subdomain gets a CNAME and an apex gets an A record, because a zone cannot carry a CNAME at its root.

Usage

outplane domain dns <HOST>

Arguments

Argument	Type	Description
`HOST`	`string`	The domain, such as app.example.com. Required.

Output

Field	Type	Description
`host`	`string`
`type`	`string`	One of `CNAME`, `A`.
`name`	`string`	The record's name in the zone: a label, or @ for the apex.
`value`	`string`	What it points at.

Examples

A subdomain

outplane domain dns app.example.com

{
  "host": "app.example.com",
  "name": "app",
  "type": "CNAME",
  "value": "domains-management.outplane.app"
}

An apex domain

outplane domain dns example.com

Read the record to create it with another tool

outplane domain dns app.example.com --json --fields type,name,value

{
  "name": "app",
  "type": "CNAME",
  "value": "domains-management.outplane.app"
}

What to Know

Local. No request is made and no credential is needed, so this answers before anything exists.
A host with three or more labels is treated as a subdomain and gets a CNAME. Two labels is an apex and gets an A record, because a zone cannot have a CNAME at its root.
The certificate follows automatically once the record resolves. There is nothing else to configure.

Errors

Beyond 0 for success, this command exits with:

Exit	Kind	Meaning
`2`	`usage`	Invalid arguments, unknown flag, or client-side validation failure.

The code on the error object is one of domain.host_invalid, usage.missing_argument. Branch on that, or on the exit status. The message is prose and changes.

domain add

domain list

List the team's custom domains.