API referenceEnvironments

Check Computer

Probe desktop readiness without capturing the screen, sending input or starting the instance.

POST/api/v1/environments/{environment_id}/computer/check

Probe desktop readiness without capturing the screen, sending input or starting the instance.

Authorization

AuthorizationBearer <token>

A workspace API key (a13n_...)

In: header

Path Parameters

environment_id*Environment Id

Header Parameters

X-Workspace-ID?|

The workspace ID a login session acts in; required with a login session. An API key acts in its own workspace and needs none; naming another is forbidden.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/environments/string/computer/check"
{  "display_count": 0,  "input_ready": false,  "observe_ready": false,  "operations": [    "environment.file.stat"  ],  "status": "checked"}