Asset Management

Awsl-RemoteX Asset Management

Use the running service API instead of editing SQLite. Resolve the base URL from AWSL_REMOTEX_URL, defaulting to http://127.0.0.1:8080.

Authentication

Call GET /api/auth/status first. If required is true, authenticate through POST /api/auth/login with {"username":"...","password":"..."} and retain the returned cookie for all later requests. Read the username from AWSL_REMOTEX_USERNAME, falling back to AUTH_USERNAME and then admin. Read the password from AWSL_REMOTEX_PASSWORD, falling back to AUTH_PASSWORD; never print credentials or place them directly in a visible command line. Stop and report the requirement if no password is set.

Asset operations

Assets use this complete writable shape:

{
  "name": "prod-web-01",
  "group": "Production",
  "protocol": "ssh",
  "host": "10.10.2.18",
  "port": 22,
  "username": "operator",
  "settings": {},
  "credentialType": "password",
  "password": "secret"
}

protocol must be ssh, rdp, or vnc. An empty group becomes the localized default group. Ports default to 22, 3389, and 5900 respectively when omitted or zero.

credentialType must be prompt, password, or private-key; private-key is only valid for SSH. Password credentials use password. Private-key credentials use privateKey and optional passphrase. Never print credentials. List responses expose only credentialType and credentialConfigured, not the stored secret. On update, blank secret fields preserve the existing credential when its type is unchanged; changing to prompt removes it.

VNC assets may explicitly override defaults with "settings":{"vnc":{"encodings":"tight","colorDepth":32,"cursor":"remote","wheelDirection":"reverse"}}. colorDepth accepts 8, 16, 24, or 32. cursor accepts remote; wheelDirection accepts reverse. Omit fields that do not need overrides, and omit settings.vnc when no override is required. Since update is a full replacement, preserve the listed asset's settings value unless the user explicitly asks to remove the override.

• List: GET /api/assets
• Create: POST /api/assets with the complete writable shape
• Read one: list assets and select the exact id; there is no separate public single-asset endpoint
• Update: PUT /api/assets/{id} with the complete writable shape; this is full replacement, not a partial patch
• Delete: DELETE /api/assets/{id} only after resolving and reporting the exact asset target
• Test a saved asset: POST /api/assets/{id}/test
• Test current form values: POST /api/assets/test with {"assetId":"<optional existing ID>","asset":{...}}

The test response contains reachable, latencyMs, and message. The server first checks target TCP reachability, then asks guacd to establish the configured protocol connection with the supplied or saved credentials. It does not open or validate the browser rendering path.

Treat 401 as missing or expired Awsl-RemoteX authentication, 404 as a stale asset ID, and other non-success responses as operation failures. Do not retry mutations automatically after an ambiguous network failure; list assets first to determine whether the change was applied.