API reference / Computer
Update the computer
Picks the colour the workspace's computer wears: its picture in Troopy, and its screen's wallpaper from the computer's next start. Setup asks for it once the computer is launching. Needs a launched computer and an owner or admin.
/api/v1/computerOther ways to call it
troopy computer updatetroopy_update_computerIdempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Body
application/jsoncolor*enum<string>The colour to wear
skytangerinevioletmintrosegraphite
Response
200 · application/jsondata*object6 properties
status*enum<string>provisioning: still launching; poll statusUrl every few seconds
provisioningreadyfailed
steps*array<object>What launching does, in order
3 properties
id*stringlabel*stringstate*enum<string>donerunningpendingfailed
error*string | nullWhy launching failed. Launch again to retry from the failed step
color*enum<string>The colour it wears in Troopy and on its screen's wallpaper; graphite until one is picked
skytangerinevioletmintrosegraphite
connection*object11 properties
provider*enum<string> | nullclaudechatgptgeminigrokcopilotopenrouterzaikimiminimaxqwenanthropicopenaicursor
method*enum<string> | nullHow the plan signs in: an API key; a code to approve on the provider's site (device_code); or signing in at the provider's site and pasting back the code it shows (paste_code). Null when Troopy can't connect the plan yet
api_keydevice_codepaste_code
status*enum<string>pending: waiting for someone to approve userCode at verificationUrl (device_code), or to sign in at verificationUrl and send the code back (paste_code)
nonependingconnectedfailed
userCode*string | nullThe code to enter at verificationUrl. Shown to owners and admins only
verificationUrl*string | nullexpiresAt*string | nullWhen userCode stops working
keyHint*string | nullThe last four characters of the API key in use
connectedAt*string | nullerror*string | nullWhy the last attempt failed, in words to show people
limitedUntil*string | nullOut of usage until then: teammates use the next plan down the list meanwhile
lapsedAt*string | nullSince when the sign-in lapsed and the plan's CLI couldn't renew it. Sign the plan in again (POST /computer/connection). Null while the sign-in is fresh
statusUrl*stringPoll this (GET) until status is ready