domain
domain point
Send a domain to an application.
writesrepeatable--dry-run
Sends an already registered domain to an application, or moves it from one to another.
Moving is this command rather than a removal and an addition: the route keeps its certificate and there is no moment where it answers nothing. The change reaches the edge within seconds and needs no deployment.
Usage
outplane domain point <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. |
--app | string | Application to point it at. Required. |
--port | int | Which of its ports. Optional when it serves one. |
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
Point a registered domain
outplane domain point app.example.com --app checkout --port 3000One route of a host that carries several
outplane domain point example.com --path /api --app api01Check which port the id belongs to first
outplane domain point app.example.com <PORT_ID> --dry-run --json{
"app": "checkout",
"changed": false,
"host": "app.example.com"
}What to Know
- A host carrying more than one route is ambiguous without --path, and the error lists the paths rather than choosing.
- Moving a domain is this command, not a remove and an add: the route keeps its certificate and there is no window where it answers nothing.
- The change reaches the edge within seconds. It needs no deployment.
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, domain.port_not_found, domain.no_ports, app.not_found, usage.missing_argument. Branch on that, or on the exit status. The message is prose and changes.