Pause a session

Pause the VM while retaining session files and VM disk state. A running managed command or provided-agent request blocks the operation.

post/v1/sessions/{id}/pause

Request

  • Base URL
    https://assemble-vms-api.fly.dev
  • URL
    https://assemble-vms-api.fly.dev/v1/sessions/{id}/pause
  • Auth
    HTTP bearer

Response

Updated session metadata.

idstring uuid required
namestring required
state'starting' | 'running' | 'paused' | 'stopped' | 'error' | 'deleting' required
rootDirectorystring required

Persistent project directory used by file operations and the default working directory for managed commands.

homeDirectorystring required

VM-local HOME for managed commands. Raw SSH uses the image login home unless the user explicitly exports this value.

createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "rootDirectory": "/workspace"
}

Changes

No recorded changes to this operation across all 1 revision of this API.