app
app rename
Change the label an application is shown under.
writesrepeatable--dry-run
Changes the label an application is shown under. The address is untouched and cannot be changed: the name that appears in a URL is fixed when the application is created.
Usage
outplane app rename <DISPLAY-NAME> [flags]Arguments
| Argument | Type | Description |
|---|---|---|
DISPLAY-NAME | string | The label to show it under. Required. |
Flags
| Flag | Type | Description |
|---|---|---|
--app | string | Application name or id. Defaults to the linked app. A flag rather than an argument, to match the rest of this group. |
The global flags apply as well.
Output
| Field | Type | Description |
|---|---|---|
app | string | The immutable name, which this does not change. |
appId | string | |
displayName | string | The new label. |
changed | bool | False for a dry run. |
Examples
Rename the linked application
outplane app rename "Checkout API"Rename another one
outplane app rename "Checkout API" --app checkoutCheck the name would be accepted, without changing anything
outplane app rename "Checkout API" --dry-run --json{
"app": "checkout",
"changed": false,
"displayName": "Checkout API"
}What to Know
- The address does not change. app in the result is the name that appears in URLs and it is fixed at creation; displayName is the label. Nothing on the platform renames the first.
- Letters, numbers, spaces and hyphens only, 1 to 45 characters. An underscore, a dot or a non-Latin letter is refused with app.display_name_invalid, before any request is made.
- Nothing needs deploying. The label is not part of the workload, so the change is visible immediately.
- There is no way to remove a display name. Setting it to the application's own name is the closest thing.
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.display_name_required, app.display_name_invalid, usage.missing_argument, context.no_app, app.not_found. Branch on that, or on the exit status. The message is prose and changes.