Computers

Create a computer

Changed on

Declare a new computer; it boots asynchronously.

post/v1/computers

Request

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

Request body

autoPauseboolean

Pause at the timeout instead of deleting, so a later resume continues where the computer left off. The pause begins about 30 seconds before the deadline.

diskMibinteger

Ignored today. Every computer gets the disk its host is configured for.

envobject
environmentIdstring uuid
idleTimeoutSecondsinteger

Pause the computer after this many seconds without incoming traffic, so a later resume continues where it left off. 0 disables idle pausing.

memoryMibinteger
namestring
projectIdstring uuid
secretsobject
templatestring
timeoutSecondsinteger

How long the computer may run before it is deleted, or paused when autoPause is set. A resume starts a fresh window.

vcpuinteger

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