2026-09-30 12:39:06 -04:00
|
|
|
---
|
|
|
|
|
# Code generated by make gen. DO NOT EDIT.
|
|
|
|
|
title: "`coder workspace-proxy edit`"
|
2026-10-20 18:51:44 -04:00
|
|
|
description: Edit a workspace proxy.
|
2026-09-30 12:39:06 -04:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
<!-- DO NOT EDIT | GENERATED CONTENT -->
|
|
|
|
|
|
|
|
|
|
Edit a workspace proxy
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
coder workspace-proxy edit [flags] <name|id>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Options
|
|
|
|
|
|
|
|
|
|
### -c, --column
|
|
|
|
|
|
2026-10-21 10:58:04 -07:00
|
|
|
| Property | Value |
|
|
|
|
|
|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
|
|
|
| Type | <code>[id\|name\|display name\|icon url\|healthy\|url\|wildcard hostname\|derp enabled\|derp only\|proxy status\|proxy report\|proxy checked at\|created at\|updated at\|deleted\|version]</code> |
|
|
|
|
|
| Default | <code>name,url</code> |
|
2026-09-30 12:39:06 -04:00
|
|
|
|
|
|
|
|
Columns to display in table output.
|
|
|
|
|
|
|
|
|
|
### -o, --output
|
|
|
|
|
|
2026-10-21 10:58:04 -07:00
|
|
|
| Property | Value |
|
|
|
|
|
|----------|--------------------------------|
|
|
|
|
|
| Type | <code>text\|json\|table</code> |
|
|
|
|
|
| Default | <code>text</code> |
|
2026-09-30 12:39:06 -04:00
|
|
|
|
|
|
|
|
Output format.
|
|
|
|
|
|
|
|
|
|
### --name
|
|
|
|
|
|
2026-10-21 10:58:04 -07:00
|
|
|
| Property | Value |
|
|
|
|
|
|----------|---------------------|
|
|
|
|
|
| Type | <code>string</code> |
|
2026-09-30 12:39:06 -04:00
|
|
|
|
|
|
|
|
(Optional) Name of the proxy. This is used to identify the proxy.
|
|
|
|
|
|
|
|
|
|
### --display-name
|
|
|
|
|
|
2026-10-21 10:58:04 -07:00
|
|
|
| Property | Value |
|
|
|
|
|
|----------|---------------------|
|
|
|
|
|
| Type | <code>string</code> |
|
2026-09-30 12:39:06 -04:00
|
|
|
|
|
|
|
|
(Optional) Display name of the proxy. A more human friendly name to be displayed.
|
|
|
|
|
|
|
|
|
|
### --icon
|
|
|
|
|
|
2026-10-21 10:58:04 -07:00
|
|
|
| Property | Value |
|
|
|
|
|
|----------|---------------------|
|
|
|
|
|
| Type | <code>string</code> |
|
2026-09-30 12:39:06 -04:00
|
|
|
|
|
|
|
|
(Optional) Display icon of the proxy.
|