GET
/
workspaceagents
/
{workspaceagent}
/
listening-ports
curl --request GET \
  --url https://cloud.local.wirtual.dev/api/v2/workspaceagents/{workspaceagent}/listening-ports \
  --header 'Wirtual-Session-Token: <api-key>'
{
  "ports": [
    {
      "network": "<string>",
      "port": 123,
      "process_name": "<string>"
    }
  ]
}

Authorizations

​
Wirtual-Session-Token
string
header
required

Path Parameters

​
workspaceagent
string
required

Workspace agent ID

Response

200 - application/json
OK
​
ports
object[]

If there are no ports in the list, nothing should be displayed in the UI. There must not be a "no ports available" message or anything similar, as there will always be no ports displayed on platforms where our port detection logic is unsupported.