domain
domain unpoint
Stop a domain going anywhere, keeping it registered.
writesrepeatable--dry-run
Takes a domain out of service while keeping it. Traffic stops at once, the registration and the certificate stay, and pointing it somewhere again needs no DNS change.
This is also the command that has to run before an application with a domain attached can be deleted.
Usage
outplane domain unpoint <HOST> [flags]Arguments
| Argument | Type | Description |
|---|---|---|
HOST | string | The domain, such as app.example.com. Required. |
Flags
| Flag | Type | Description |
|---|---|---|
--path | string | Which route on the host, defaulting to the root. Needed only when the host carries several. |
The global flags apply as well.
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
Take a domain out of service without giving it up
outplane domain unpoint app.example.comSee what it points at now
outplane domain unpoint app.example.com --dry-run --json{
"app": null,
"changed": false,
"host": "app.example.com"
}Leave the route in place, pointing nowhere
outplane domain unpoint app.example.com --json --fields host,changedWhat to Know
- Idempotent. A route that already points nowhere reports changed false and exits 0.
- Traffic stops immediately. The certificate and the registration are kept, so pointing it again needs no DNS change.
- This is what an application needs before it can be deleted, since the platform refuses to delete one with a domain attached.
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. |
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 domain.not_found, domain.ambiguous, usage.missing_argument. Branch on that, or on the exit status. The message is prose and changes.