domain remove

destructive--dry-run

Gives up the domain entirely: the registration and the certificate go with it.

To stop serving a domain but keep it, use domain unpoint instead. Traffic stops immediately here, before any DNS change of your own has taken effect.

Usage

outplane domain remove <HOST> [flags]

Arguments

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

Flag	Type	Description
`--path`	`string`	Which route on the host, defaulting to the root. Needed only when the host carries several.
`-y`, `--yes`	`bool`	Acknowledge the removal. Not sufficient on its own.
`--confirm-name`	`string`	The host, typed again.

Output

Field	Type	Description
`id`	`string \| null`
`host`	`string`
`path`	`string`	Trailing slashes are stripped; the root is /.
`app`	`string \| null`	Null while the route points nowhere.
`appId`	`string \| null`
`portId`	`string \| null`	The port record the route binds to.
`ssl`	`bool`	Always true: a certificate is issued for every custom domain.
`url`	`string \| null`	The address the route answers on.
`changed`	`bool`

Examples

See what would stop answering

outplane domain remove app.example.com --dry-run

The confirmed form

outplane domain remove app.example.com --yes --confirm-name app.example.com

Check which route the host resolves to

outplane domain remove app.example.com --dry-run --json

{
  "changed": false,
  "host": "app.example.com",
  "path": "/"
}

What to Know

Never prompts. Without confirmation it exits 4 and returns the command to replay in the error's confirm_command field.
Under a detected agent harness it exits 4 even with both flags.
To take a domain out of service and keep it, use domain unpoint. This gives up the registration and the certificate.
Traffic stops immediately, before any DNS change of yours takes effect.

Errors

Beyond 0 for success, this command exits with:

Exit	Kind	Meaning
`2`	`usage`	Invalid arguments, unknown flag, or client-side validation failure.
`3`	`auth`	Not authenticated, token revoked or expired, or forbidden for this team.
`4`	`confirmation_required`	A destructive operation stopped. Replay the command in confirm_command.
`5`	`not_found`	The named resource does not exist, or is not visible to this credential.
`8`	`upstream`	The Out Plane API returned a server error.

The code on the error object is one of confirmation.required, domain.confirm_name_mismatch, domain.not_found, domain.ambiguous. Branch on that, or on the exit status. The message is prose and changes.

domain unpoint

Stop a domain going anywhere, keeping it registered.

domain list

List the team's custom domains.