Legacy Sandbox Snapshot Template

​

Terminology

• Commit: A commit operation saves the current state of a sandbox as a template, resulting in a new template of type snapshot template.
• Origin Sandbox: The sandbox instance being committed.
• Snapshot Template: The template generated after a commit operation.

​

Feature Description

​

Committing a Running Sandbox

• The origin sandbox will be briefly suspended during committing;
• The sandbox instance is unavailable during suspension;
• The suspension duration is close to the time required for a single pause operation.

• The existing pause record will be refreshed to a new pause record, based on the current sandbox state;
• The origin sandbox continues to run;
• A new template record is generated.

​

Committing a Paused Sandbox

• The commit process will not trigger the origin sandbox to start;
• The origin sandbox remains in paused state.

• The existing pause record is not cleared;
• A new template record is generated.

​

Parameter Description

​

Return Value

​

Code Examples

from novita_sandbox.core import Sandbox

# Commit an existing sandbox by ID to create a template snapshot
# sandbox_id: str - Required. The ID of the sandbox to commit
# alias: Optional[str] - Optional alias name for the created template
# Note: Default timeout is 10 minutes for commit operation
template = Sandbox.commit(
    sandbox_id="existing-sandbox-id",
    alias="my-template-alias"
)
print(f"Template ID: {template.template_id}")
print(f"Build ID: {template.build_id}")

import { Sandbox } from '@novita-sandbox/core'

// Commit an existing sandbox by ID to create a template snapshot
// sandboxId: string - Required. The ID of the sandbox to commit
// opts?: { alias?: string } - Optional commit options
const template = await Sandbox.commit('existing-sandbox-id', {
  alias: 'my-template-alias'
})
console.log(`Template ID: ${template.templateId}`)
console.log(`Build ID: ${template.buildId}`)

# Basic commit - creates a template snapshot from a sandbox
novita-sandbox-cli sandbox commit <sandboxID>

# Commit with alias - assign a friendly name to the template
novita-sandbox-cli sandbox commit <sandboxID> --alias my-template-alias