Skip to main content
POST
Start computer
Starts a computer that is frozen or stopped. A frozen computer’s archived disk is restored, including files, installed software, and configuration, and it cold-boots on a host chosen for it. A stopped computer whose virtual machine is still on its host is booted there from its own disk instead.
A computer started from its archive gets a new instance_id, and it can land on a different host with a different address and ports. Orgo asks for the previous ports and VNC password back, but does not guarantee them. Re-fetch GET /computers/{id} afterwards. Only the disk is restored: processes and other in-memory state from before the stop are gone. The call can take considerably longer than a normal request while the saved disk is fetched and the computer boots.

Path parameters

string
required
Computer UUID or instance_id. Both resolve to the same computer. A frozen computer has no instance_id, so address it by UUID.

Query parameters

string
default:"false"
true or false. true returns 202 immediately instead of waiting, as described in Return immediately and poll. Any other value returns 400.

Response

boolean
true when the start succeeded or the computer was already running.
boolean
Present and true only when the computer’s record said stopped but the computer was still running on its host, so the record was corrected instead of a second copy being booted. No boot happened.
boolean
Present and true only when a stopped computer was booted on its existing host from its own disk, rather than restored from its archive.
Starting is idempotent for an already-running computer: it returns { "success": true } and changes nothing. Only frozen and stopped computers are startable. Every other status, including suspended, returns 409.

Example

Response

Errors

A failure that happens while the operation runs also carries operation_id and poll_url in its body.

Return immediately and poll

Send ?async=true, a JSON body { "async": true }, or the header Prefer: respond-async to return 202 immediately. The response includes id (the computer UUID), status (starting or stopping), operation_id, operation, and poll_url, plus Location and Retry-After: 2 headers. Repeating the same action while it is pending returns the same operation. An opposite action returns 409 with code OPERATION_IN_PROGRESS. Fetch poll_url with the same authentication until the operation reports succeeded, failed, or needs_review. A needs_review result means the host’s outcome is uncertain. Orgo checks the computer and settles the operation on its own; until then, a new start or stop returns 409 with code OPERATION_NEEDS_REVIEW. See Get computer operation. Without the async option the request waits for completion, up to 300 seconds. If still pending, it returns 202 and the same polling fields. Both modes preserve disk data; stopping discards live processes and memory, and starting cold-boots with potentially different connection details.

Authorizations

Authorization
string
header
required

API key authentication. Get your key at orgo.ai/workspaces

Headers

Prefer
enum<string>

Send respond-async for the same effect as ?async=true.

Available options:
respond-async

Path Parameters

id
string
required

Computer ID

Query Parameters

async
enum<string>
default:false

true returns 202 immediately instead of waiting. Omitted, the request waits up to 300 seconds. Any value other than true or false returns 400.

Available options:
true,
false

Body

application/json
async
boolean
default:false

true returns 202 immediately. An empty body is accepted; any body that is not a JSON object with an optional boolean async returns 400.

Response

Started, or already running

success
boolean
Example:

true

reconciled
boolean

Present and true only when the record said stopped but the computer was still running on its host, so the record was corrected. No boot happened.

restarted
boolean

Present and true only when a stopped computer was booted on its existing host from its own disk.