API reference / Computer
Open the computer's screen
A link to the workspace's computer screen, to watch its teammates work and take over the mouse and keyboard, for instance to sign in to a site. Every teammate has its own browser on it, with its own sign-ins; name one in agent to bring its window to the front. The link carries its own access token: whoever has it controls the computer, so treat it as a secret and never log it. The default is a 60 fps stream that can be embedded; vnc true asks for a slower view that works on strict networks and must open as a page of its own. preparing true means the screen is still being set up: call again in a few seconds. Boots a stopped computer first, which can take up to two minutes. Needs an owner or admin.
/api/v1/computer/desktopOther ways to call it
troopy computer desktopBody
application/jsonvncbooleanThe VNC view, for networks where the stream won't connect
Default false
agentstringA teammate whose own browser comes to the front first, opening on its home page if it isn't running
At most 40 characters
Response
200 · application/jsondata*object2 properties
url*string | nullThe screen's link, secret-bearing. Null while preparing
preparing*booleanThe screen is still being set up: call again in a few seconds