Computers

Create a computer from a checkpoint

Changed on

Start a new computer from a ready checkpoint; it restores asynchronously.

post/v1/checkpoints/{id}/computers

Request

  • Base URL
    https://api.steel.dev
  • URL
    https://api.steel.dev/v1/checkpoints/{id}/computers
  • Auth
    • API key in header steel-api-key
    • or none

Path parameters

idstring required

Request body

autoPauseboolean

Pause at the timeout instead of deleting.

idleTimeoutSecondsinteger

Pause the restored computer after this many seconds without incoming traffic. 0 disables idle pausing.

projectIdstring uuid

Required for organization-scoped API keys. Must match the source computer's project; cross-project restore is not supported. Project-scoped keys use their bound project.

timeoutSecondsinteger

How long the restored computer may run before it is deleted, or paused when autoPause is set.

Response

Default Response

autoPauseboolean required
checkpointIdstring nullable required
diskMibinteger required
environmentIdstring uuid nullable required
idstring required
idleTimeoutSecondsinteger required
memoryMibinteger required
projectIdstring uuid required
status'none' | 'creating' | 'running' | 'pausing' | 'paused' | 'waking' | 'stopped' | 'failed' | 'deleting' | 'deleted' required
statusChangedAtstring date-time required
templatestring nullable required
timeoutSecondsinteger nullable required
vcpuinteger required

Changes