Barrack API Documentation
  1. backup
Barrack API Documentation
  • Platform Documentation
    • "Authentication & Access"
    • "Getting Started"
    • "Platform Documentation"
    • "Troubleshooting"
    • vm
      • "Advanced Configuration"
      • "Boot Source Configuration"
      • "GPU Configuration"
      • "Region Selection"
      • "SSH Key Configuration"
      • "VM States & Billing"
    • storage
      • "Managing Volumes"
      • "Storage Management"
    • ssh
      • "Creating SSH Keys"
      • "Importing SSH Keys"
      • "Managing SSH Keys"
    • security
      • "Attaching Firewalls to VMs"
      • "Firewall Management"
      • "Firewall Rules"
    • dashboard
      • "Dashboard Overview"
      • "VM Management"
    • backup
      • "Creating Snapshots"
      • "Custom Images"
      • "Managing Snapshots"
      • "Restoring Snapshots"
      • "Snapshots Management"
    • account
      • "Credits System"
      • "Account Management"
  • Balance
    • Get credit balance
      GET
  • GPU Stocks
    • Get GPU stock availability
      GET
  • GPU Specs
    • Get GPU specifications
      GET
  • Regions
    • List available regions
      GET
  • Pricing
    • Get pricing information
      GET
    • Get pricing information
      POST
  • Deploy Instance
    • Create a new instance
      POST
  • Instance management
    • List instances
    • Delete instance
    • Get instance billing
    • Hibernate instance
    • Reboot instance
    • Restore hibernated instance
    • Start instance
    • Stop instance
    • Toggle public IP for instance
    • Get instance details
    • Get hibernated instances count
    • Add instance security rule
    • Remove instance security rule
  • OS Images
    • List OS images
  • SSH Keys
    • List SSH keys
    • Create SSH key
    • Get SSH key
    • Delete SSH key
  • Scripts
    • List all startup scripts
    • Create a startup script
    • Get startup script details
    • Update a startup script
    • Delete a startup script
    • Delete multiple startup scripts
  • Firewalls
    • List firewalls
    • Get firewall details
    • Attach firewall to instances
    • Get firewalls attached to instance
    • Delete firewall
    • Remove firewall rule
    • Add firewall rule
    • Create firewall
    • Get supported protocols
    • List instances available for firewall attachment
    • List instances available for firewall attachment
  • Snapshots
    • List snapshots
    • Get snapshot billing
    • List Instance eligible for snapshot creation
    • Get snapshot details
    • Delete snapshot
    • Restore snapshot
    • Create snapshot
    • Create snapshot
    • Get snapshot billing
  • Images
    • List custom images
    • Get image details
    • Delete custom image
    • Create image from snapshot
    • Get snapshot-image relationship
    • Get snapshot-image relationship list
  • AI Chat
    • Chat with AI
    • Get AI usage summary
    • Get AI usage history
    • Get available AI models
  • Volumes
    • Attach volumes to instance
    • Detach volumes from instance
    • Clone volume
    • Resize volume
    • Get volume billing
    • List available volume types
    • List volumes
    • Create volume
    • Get volume details
    • Delete volume
  • Virtual Machines
    • Get firewalls attached to instance
    • Remove instance security rule
    • List Instance eligible for snapshot creation
  • Schemas
    • AITransaction
    • AddFirewallRuleRequest
    • AddFirewallRuleResponse
    • AddVMSecurityRuleResponse
    • AttachFirewallRequest
    • AggregatedBillingResponse
    • AttachFirewallResponse
    • AttachVolumesRequest
    • AttachVolumesResponse
    • AttachedFirewall
    • BatchSnapshotImageRelationshipResponse
    • Balance
    • Billing
    • ChatCompletionsRequest
    • ChatCompletionsResponse
    • CloneVolumeRequest
    • BillingRecord
    • CloneVolumeResponse
    • BillingSummary
    • CreateFirewallRequest
    • CreateFirewallResponse
    • CreateImageFromSnapshotRequest
    • CreateSSHKeyRequest
    • CreateScriptRequest
    • CreateSnapshotRequest
    • CreateSnapshotResponse
    • CreateSSHKeyResponse
    • CurrencyEnum
    • Data
    • CreditBalanceResponse
    • DeleteFirewallResponse
    • CreateVolumeRequest
    • DeleteSnapshotResponse
    • CreateVolumeResponse
    • DeleteVMResponse
    • DetachVolumesRequest
    • DetachVolumesResponse
    • DeploymentRequest
    • DirectionEnum
    • DeploymentResponse
    • EthertypeEnum
    • ErrorResponse
    • FirewallAttachment
    • DeleteVolumeResponse
    • DeleteSSHKeyResponse
    • FirewallEnvironment
    • FirewallResponse
    • FirewallRule
    • FirewallVM
    • GetBatchSnapshotImageRelationshipsRequest
    • GetFirewallDetailsResponse
    • GPUStockConfiguration
    • GPUSpec
    • GetHibernatedVMsResponse
    • GPUStockItem
    • GPUSpecsResponse
    • GetSupportedProtocolsResponse
    • GPUStocksResponse
    • GetVMAttachedFirewallsResponse
    • GetVolumeTypesResponse
    • HibernateVMResponse
    • HibernationBillingMetrics
    • ListFirewallsResponse
    • ListUserVMsResponse
    • ListVMsResponse
    • ModelsResponse
    • GetSSHKeysResponse
    • Pagination
    • PricingRequest
    • OSImage
    • PricingResponse
    • OSImagesResponse
    • Protocol
    • GpuCountEnum
    • ProtocolEnum
    • Image
    • GpuModelEnum
    • GetVolumeDetailsResponse
    • RebootVMResponse
    • ImageCreateResponse
    • RecentHibernation
    • ImageDeleteResponse
    • GetVolumesWithNextNameResponse
    • RemoveFirewallRuleResponse
    • ImageDetailResponse
    • RemoveVMSecurityRuleResponse
    • Region
    • ImageListResponse
    • ResizeVolumeRequest
    • RegionsResponse
    • Price
    • ResizeVolumeResponse
    • ResourceTypeEnum
    • RestoreSnapshotRequest
    • RestoreSnapshotResponse
    • RestoreVMResponse
    • Snapshot
    • SnapshotImageRelationshipResponse
    • Specs
    • StartVMResponse
    • StopVMResponse
    • TierEnum
    • UpdateScriptRequest
    • UsageHistoryResponse
    • UsageSummaryResponse
    • RegionEnum
    • UserVM
    • VMDetailsResponse
    • VMFlavor
    • VMImage
    • VMInstance
    • VMResponse
    • SpecsMetadata
    • VMSecurityRule
    • VMSecurityRuleRequest
    • VMStatus
    • VMVolumeAttachment
    • Script
    • VolumeTypeEnum
    • SSHKeyResponse
    • ScriptListResponse
    • ToggleVMPublicIPResponse
    • VolumeBillingRecord
    • VolumeBillingSummary
    • VolumeHourlyBillingResponse
    • VolumeResponse
  1. backup

"Creating Snapshots"

Create point-in-time backups of your virtual machines to preserve their current state, data, and configuration.
Before creating snapshots, ensure you meet these requirements:

Account Requirements#

1
Complete Profile
Ensure your account profile is complete with all required billing information
2
Sufficient Credits
Verify you have adequate credits for snapshot storage costs
3
Active VMs
Have at least one VM in ACTIVE state available for snapshotting
4
Regional Planning
Plan which region you want to store your snapshots in

Step-by-Step Creation Process#

To create a new snapshot:
1
Navigate to Snapshots
Navigate to the Snapshots page
2
Select Region
Select your desired region from the dropdown menu
3
Initiate Creation
Click the "Create Snapshot" button (disabled if no active VMs are available)
4
Configure Snapshot
In the Create Snapshot modal:
Select a virtual machine from the dropdown
Enter a unique snapshot name (required, 1-50 characters)
Optionally click "Show advanced options" for additional settings
5
Advanced Options (Optional)
Configure advanced settings:
Add description text for documentation
Toggle "Create as Image" for deployment templates
6
Create Snapshot
Review your settings and click "Create Snapshot"

Basic Configuration#

Virtual Machine Selection#

VM Dropdown
Available VMs
Dropdown shows only ACTIVE VMs in the selected region
Displays VM name, GPU type, and region for easy identification
Example format: "my-vm - H100-SXM5-80GB (CANADA-1)"
If no VMs are available, you'll see "No active VMs available"
VM Requirements
Eligible VMs
VM must be in ACTIVE state
VM must be fully operational and responsive
VM should not be under heavy load during snapshot creation
VM must have completed initial setup and configuration

Snapshot Naming#

Naming Requirements
Naming Best Practices
Validation Feedback

Advanced Options#

Click "Show advanced options" to access additional configuration settings:

Description Field#

Documentation
Snapshot Description
Optional text area for snapshot description
Helps identify the snapshot's purpose
Useful for team collaboration and documentation
No character limit enforced in UI
Supports detailed documentation of snapshot contents
Best Practices
Description Content
Include snapshot purpose and contents
Document software versions and configurations
Note any special considerations for restoration
Include contact information for questions
Document dependencies and requirements

Create as Image Option#

Image Creation
Image Benefits
Use Cases
Snapshot as Deployment Template
Toggle switch to create snapshot as an image
Images can be used for future VM deployments
Appears in boot source options during VM creation
Useful for standardizing environments across team

Creation Process Details#

Snapshot Creation Workflow#

1
Validation
System validates all input parameters and requirements
2
Initiation
Snapshot creation begins with VM state capture
3
Data Capture
Complete VM state, disk contents, and configuration captured
4
Compression
Snapshot data compressed and optimized for storage
5
Verification
Snapshot integrity verified and marked as available

Creation Process Monitoring#

Progress Tracking
Error Handling
Success Confirmation

Snapshot Creation Timing#

Optimal Creation Windows#

Low Activity Periods
Best Times for Snapshots
During low VM activity or maintenance windows
Outside of peak application usage hours
Between batch processing jobs
During scheduled maintenance periods
Avoid High Load
Times to Avoid
During heavy computational workloads
Peak user activity periods
During backup or synchronization operations
System update or installation processes

Performance Considerations#

VM Performance Impact
Duration Estimates
Resource Optimization

Snapshot Storage and Costs#

Storage Optimization#

Cost Management#

Storage Costs
Cost Optimization
Budget Planning
Billing Information
Rate: $0.1 per TB per hour (€0.1 per TB per hour | ₹10 per TB per hour)
Billing Method: Hourly based on actual snapshot size
Compression: Snapshots are compressed to reduce costs
No Transfer Costs: No charges for snapshot creation or restoration

Troubleshooting Snapshot Creation#

Common Creation Issues#

VM State Issues
Account Issues
Resource Issues
Technical Issues
VM Not Available
Problem: No VMs available for snapshotting
Solution: Ensure at least one VM is in ACTIVE state
Verification: Check VM status in dashboard
Prevention: Maintain VMs in operational state

Error Resolution#

1
Identify Issue
Review error messages carefully
Check VM status and health
Verify account and credit status
Assess current system load
2
Apply Solution
Address specific error conditions
Wait for VM to reach stable state if needed
Add credits or complete profile as required
Retry during optimal conditions
3
Verify Success
Monitor snapshot creation progress
Verify snapshot appears in list
Check snapshot status reaches "Success"
Test snapshot accessibility
4
Prevent Recurrence
Document successful procedures
Plan optimal timing for future snapshots
Monitor account and resource status
Establish regular snapshot schedule
Previous
"VM Management"
Next
"Custom Images"
Built with