Skip to content

POST /sandboxes/{sandboxID}/pause ​

Pause sandbox

Pause the sandbox

Parameters ​

  • sandboxID · string · path · required

Request body ​

Required: no

application/json ​

Schema: SandboxPauseRequest

  • memory · boolean · optional

    Whether to capture a full memory snapshot. When false, only the filesystem is persisted and resuming the sandbox cold-boots (reboots) it from disk, losing in-memory state, running processes, and open connections. Resume it with an explicit request (connect or resume); auto-resume, which can be triggered by arbitrary traffic, refuses such a sandbox. Defaults to true.

    Default: true

Responses ​

204 ​

The sandbox was paused successfully and can be resumed

409 ​

Conflict

Content-Type: application/json

Schema: Error

  • code · integer · required

    Error code

    Format: int32

  • message · string · required

    Error

404 ​

Not found

Content-Type: application/json

Schema: Error

  • code · integer · required

    Error code

    Format: int32

  • message · string · required

    Error

401 ​

Authentication error

Content-Type: application/json

Schema: Error

  • code · integer · required

    Error code

    Format: int32

  • message · string · required

    Error

500 ​

Server error

Content-Type: application/json

Schema: Error

  • code · integer · required

    Error code

    Format: int32

  • message · string · required

    Error