GET
/
workspaceagents
/
{workspaceagent}
curl --request GET \
  --url https://cloud.local.wirtual.dev/api/v2/workspaceagents/{workspaceagent} \
  --header 'Wirtual-Session-Token: <api-key>'
{
  "api_version": "<string>",
  "apps": [
    {
      "command": "<string>",
      "display_name": "<string>",
      "external": true,
      "health": "disabled",
      "healthcheck": {
        "interval": 123,
        "threshold": 123,
        "url": "<string>"
      },
      "hidden": true,
      "icon": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sharing_level": "<any>",
      "slug": "<string>",
      "subdomain": true,
      "subdomain_name": "<string>",
      "url": "<string>"
    }
  ],
  "architecture": "<string>",
  "connection_timeout_seconds": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "directory": "<string>",
  "disconnected_at": "2023-11-07T05:31:56Z",
  "display_apps": [
    "vscode"
  ],
  "environment_variables": {},
  "expanded_directory": "<string>",
  "first_connected_at": "2023-11-07T05:31:56Z",
  "health": {
    "healthy": false,
    "reason": "agent has lost connection"
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "instance_id": "<string>",
  "last_connected_at": "2023-11-07T05:31:56Z",
  "latency": {},
  "lifecycle_state": "created",
  "log_sources": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "display_name": "<string>",
      "icon": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workspace_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "logs_length": 123,
  "logs_overflowed": true,
  "name": "<string>",
  "operating_system": "<string>",
  "ready_at": "2023-11-07T05:31:56Z",
  "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scripts": [
    {
      "cron": "<string>",
      "display_name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "log_path": "<string>",
      "log_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "run_on_start": true,
      "run_on_stop": true,
      "script": "<string>",
      "start_blocks_login": true,
      "timeout": 123
    }
  ],
  "started_at": "2023-11-07T05:31:56Z",
  "startup_script_behavior": "<any>",
  "status": "connecting",
  "subsystems": [
    "envbox"
  ],
  "troubleshooting_url": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "version": "<string>"
}

Authorizations

​
Wirtual-Session-Token
string
header
required

Path Parameters

​
workspaceagent
string
required

Workspace agent ID

Response

200 - application/json
OK
​
api_version
string
​
apps
object[]
​
architecture
string
​
connection_timeout_seconds
integer
​
created_at
string
​
directory
string
​
disconnected_at
string
​
display_apps
enum<string>[]
Available options:
vscode,
vscode_insiders,
web_terminal,
port_forwarding_helper,
ssh_helper
​
environment_variables
object
​
expanded_directory
string
​
first_connected_at
string
​
health
object

Health reports the health of the agent.

​
id
string
​
instance_id
string
​
last_connected_at
string
​
latency
object

DERPLatency is mapped by region name (e.g. "New York City", "Seattle").

​
lifecycle_state
enum<string>
Available options:
created,
starting,
start_timeout,
start_error,
ready,
shutting_down,
shutdown_timeout,
shutdown_error,
off
​
log_sources
object[]
​
logs_length
integer
​
logs_overflowed
boolean
​
name
string
​
operating_system
string
​
ready_at
string
​
resource_id
string
​
scripts
object[]
​
started_at
string
​
startup_script_behavior
any
​
status
enum<string>
Available options:
connecting,
connected,
disconnected,
timeout
​
subsystems
enum<string>[]
Available options:
envbox,
envbuilder,
exectrace
​
troubleshooting_url
string
​
updated_at
string
​
version
string