COcoder
Enterprise

Get workspace proxy

Changed on
get/api/v2/workspaceproxies/{workspaceproxy}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v2/workspaceproxies/{workspaceproxy}
  • Auth
    API key in header Coder-Session-Token

Path parameters

workspaceproxystring uuid required

Proxy ID or name

Response

OK

created_atstring date-time
deletedboolean
derp_enabledboolean
derp_onlyboolean
display_namestring
healthyboolean
icon_urlstring
idstring uuid
namestring
path_app_urlstring

PathAppURL is the URL to the base path for path apps. Optional unless wildcard_hostname is set. E.g. https://us.example.com

updated_atstring date-time
versionstring
wildcard_hostnamestring

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.

Changes