trickroom / Docs
Sign in
API reference/users

Snapshot a user's Docker computer

Queues behind the user's jobs, stops the computer, and commits its disk to an image on its host: files and installed software, not memory or volumes. The user's later jobs wait for it. It is never restored onto the user's computer and never leaves the application. Kept `expires_in_days` (1 to 30, default 7), until deleted, or until the computer is deleted; a computer keeps at most 5 and a workspace 50. While it is taken it counts against the organization's concurrent jobs; one not taken within a day fails. Docker computers only.

POST/v1/users/{id}/computer/snapshots

Authorization

Authorizationstringrequired

Bearer tak_… — an application API key. Keep it on your backend; all resources are scoped to that application.

Create an application key →

Path parameters

idstringrequired

Min length: 1

Body application/json

expires_in_daysinteger

Minimum: 1 · Maximum: 30

Response

201Snapshot a user's Docker computer
X-Request-Idstring

Server-generated request identifier for logs and support.

application/json

idstringrequired

Min length: 1

user_idstringrequired

Min length: 1

computer_idstringrequired

Min length: 1

application_idstringrequired

Min length: 1

statusstringrequired

Allowed: "pending""capturing""ready""failed""deleting""deleted"

errorstring | nullrequired
size_bytesnumber | nullrequired
expires_atstringrequired

Format: date-time · Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

ready_atstring | nullrequired
deleted_atstring | nullrequired
created_atstringrequired

Format: date-time · Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

4XX400 invalid input; 401 missing/revoked credentials; 403 disallowed operation/application; 404 missing or inaccessible resource; 409 conflicting submission/version/state; 413 body too large; 415 unsupported content type. Inspect error.code, not message text.
X-Request-Idstring

Server-generated request identifier for logs and support.

application/json

errorobjectrequired
Object fields
codestringrequired
messagestringrequired
request_idstringrequired

Additional keys: any

5XX500 unexpected failure or 503 unavailable dependency. A failed response does not prove that a submission was not committed. Retry job/flow admission with the same key and body.
X-Request-Idstring

Server-generated request identifier for logs and support.

application/json

errorobjectrequired
Object fields
codestringrequired
messagestringrequired
request_idstringrequired

Additional keys: any