domain
domain list
List the team's custom domains.
read onlyrepeatable
Every custom domain in the team, with the application and port each one reaches.
A host can appear more than once, once per path. The host and the path together are what identify a route. A route with no application is registered and answering nothing.
Usage
outplane domain list [flags]Flags
| Flag | Type | Description |
|---|---|---|
--app | string | Only the routes going to this application. |
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. |
Examples
Every domain in the team
outplane domain listWhat one application answers on
outplane domain list --app checkoutRead the routes in a pipeline
outplane domain list --json --fields host,path,app{
"items": [
{
"app": "checkout",
"host": "app.example.com",
"path": "/"
}
],
"total": 1,
"truncated": false
}What to Know
- One host can appear several times, once per path. The pair identifies a route; the host alone does not.
- app is null for a route that points nowhere. It is registered, holds the host, and answers nothing.
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 app.not_found, context.no_team. Branch on that, or on the exit status. The message is prose and changes.