PATCH
/
workspaceproxies
/
{workspaceproxy}
curl --request PATCH \
  --url https://cloud.local.wirtual.dev/api/v2/workspaceproxies/{workspaceproxy} \
  --header 'Content-Type: application/json' \
  --header 'Wirtual-Session-Token: <api-key>' \
  --data '{
  "display_name": "<string>",
  "icon": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "regenerate_token": true
}'
{
  "created_at": "2023-11-07T05:31:56Z",
  "deleted": true,
  "derp_enabled": true,
  "derp_only": true,
  "display_name": "<string>",
  "healthy": true,
  "icon_url": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "path_app_url": "<string>",
  "status": {
    "checked_at": "2023-11-07T05:31:56Z",
    "report": {
      "errors": [
        "<string>"
      ],
      "warnings": [
        "<string>"
      ]
    },
    "status": "ok"
  },
  "updated_at": "2023-11-07T05:31:56Z",
  "version": "<string>",
  "wildcard_hostname": "<string>"
}

Authorizations

​
Wirtual-Session-Token
string
header
required

Path Parameters

​
workspaceproxy
string
required

Proxy ID or name

Body

application/json
Update workspace proxy request
​
display_name
string
required
​
icon
string
required
​
id
string
required
​
name
string
required
​
regenerate_token
boolean

Response

200 - application/json
OK
​
created_at
string
​
deleted
boolean
​
derp_enabled
boolean
​
derp_only
boolean
​
display_name
string
​
healthy
boolean
​
icon_url
string
​
id
string
​
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
object

Status is the latest status check of the proxy. This will be empty for deleted proxies. This value can be used to determine if a workspace proxy is healthy and ready to use.

​
updated_at
string
​
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.