---
title: "Update workspace proxy"
method: PATCH
path: "/api/v2/workspaceproxies/{workspaceproxy}"
tags: ["Enterprise"]
---

# Update workspace proxy

`PATCH /api/v2/workspaceproxies/{workspaceproxy}`

## Path parameters

- `workspaceproxy` string, uuid, required

## Request body

- CodersdkPatchWorkspaceProxy
  - `display_name` string, required
  - `icon` string, required
  - `id` string, uuid, required
  - `name` string, required
  - `regenerate_token` boolean

## Response `200`

OK

- CodersdkWorkspaceProxy
  - `created_at` string, date-time
  - `deleted` boolean
  - `derp_enabled` boolean
  - `derp_only` boolean
  - `display_name` string
  - `healthy` boolean
  - `icon_url` string
  - `id` string, uuid
  - `name` string
  - `path_app_url` string — PathAppURL is the URL to the base path for path apps. Optional unless wildcard_hostname is set. E.g. https://us.example.com
  - `status` CodersdkWorkspaceProxyStatus
    - `checked_at` string, date-time
    - `report` CodersdkProxyHealthReport
      - `errors` string[] — Errors are problems that prevent the workspace proxy from being healthy
      - `warnings` string[] — Warnings do not prevent the workspace proxy from being healthy, but should be addressed.
    - `status` 'ok' | 'unreachable' | 'unhealthy' | 'unregistered'
  - `updated_at` string, date-time
  - `version` string
  - `wildcard_hostname` string — WildcardHostname is the wildcard hostname for subdomain apps. E.g. *.us.example.com E.g. *--suffix.au.example.com Optional. Does not need to be on the same domain as PathAppURL.

---

[API](https://skmtc.net/coder/apis/coder-api.md) · [All operations](https://skmtc.net/coder/apis/coder-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/coder/coder-api/versions/56b6e9f08540/schema)