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

"Snapshots Management"

The Snapshots page allows you to create point-in-time backups of your virtual machines, restore them to create new VMs, and manage your backup history.
The snapshots dashboard provides key statistics and management capabilities:
Snapshot Statistics
System Overview
Total Snapshots: Number of snapshots in the selected region
Total Storage: Combined storage used by all snapshots
Available VMs: Number of active VMs that can be snapshotted
Restorable: Number of snapshots with SUCCESS/available status
Regional Management
Region-Based Organization
Snapshots are organized by region
Use region dropdown to filter snapshots by location
Only snapshots and VMs in selected region are displayed
Snapshots are region-specific and cannot be moved between regions

Region Filtering#

Snapshots are organized by geographic region for optimal management:
US-1 Region
CANADA-1 Region
NORWAY-1 Region
United States
US-based snapshot storage
Low latency for US-based restoration
Compliance with US data regulations
Optimized for North American access

Snapshot Information Display#

Each snapshot displays comprehensive information for effective management:

Basic Snapshot Details#

Snapshot Identification
Status Information
Source VM Information

Storage and Size Information#

Storage Efficiency
Optimized Storage
Snapshots use compression to reduce storage costs
Incremental data storage where possible
Deduplication for common data blocks
Optimized for fast restoration
Size Calculation
Storage Metrics
Size shown is actual storage used
Compressed and optimized size
May be smaller than original VM disk size
Storage costs based on actual snapshot size

Pagination and Navigation#

The snapshots interface includes efficient navigation for large snapshot collections:

Navigation Features#

1
Page Display
6 snapshots displayed per page for optimal viewing
2
Navigation Controls
Previous/Next navigation buttons with direct page number selection
3
Pagination Logic
Pagination only appears when more than 6 snapshots exist
4
Responsive Design
Layout adapts for desktop and mobile viewing

Snapshot Organization#

Chronological Ordering
Regional Grouping
Status Grouping
Time-Based Organization
Snapshots ordered by creation date
Newest snapshots displayed first
Easy identification of recent backups
Historical snapshot tracking

Profile Requirements#

Snapshot Storage Costs#

Snapshots incur storage costs based on the actual compressed size:

Snapshot Lifecycle Management#

Creation to Deletion Workflow#

1
Planning
Identify VMs that need regular backups
Plan snapshot frequency based on change rates
Consider retention policies for different types of data
Plan for compliance and regulatory requirements
2
Creation
Create snapshots during low-activity periods when possible
Use descriptive names that indicate purpose and date
Add descriptions for team collaboration and documentation
Monitor creation progress and verify completion
3
Management
Regular review of snapshot inventory
Verify snapshot integrity and restorability
Monitor storage costs and optimize retention
Document snapshot purposes and retention policies
4
Cleanup
Delete old snapshots based on retention policies
Remove snapshots that are no longer needed
Archive important snapshots for long-term retention
Monitor storage usage and optimize costs

Snapshot Retention Strategies#

Daily Backups
Milestone Snapshots
Compliance Snapshots

Snapshot Operations#

Available Actions#

Create Snapshot
Backup Creation
Create point-in-time backups of VMs
Preserve complete VM state and data
Include custom configurations and software
Generate images for deployment templates
Restore Snapshot
VM Restoration
Create new VMs from snapshots
Restore complete environments instantly
Deploy multiple VMs from single snapshot
Cross-region restoration capabilities
Manage Snapshots
Lifecycle Management
View detailed snapshot information
Delete unnecessary snapshots
Monitor storage usage and costs
Organize snapshots for efficient management

Snapshot Status Monitoring#

Multi-Region Snapshot Strategy#

Cross-Region Considerations#

Disaster Recovery Planning#

1
Assess Requirements
Identify critical VMs requiring cross-region backup
Determine recovery time objectives (RTO) and recovery point objectives (RPO)
Plan for regional failover scenarios
Consider compliance and data residency requirements
2
Implement Strategy
Create snapshots in primary region for local recovery
Deploy VMs in secondary regions from snapshots when needed
Establish procedures for cross-region data synchronization
Test disaster recovery procedures regularly
3
Monitor and Maintain
Regular testing of cross-region restoration procedures
Monitor snapshot consistency across regions
Update disaster recovery plans based on changing requirements
Train team on disaster recovery procedures

Snapshot Best Practices#

Operational Best Practices#

Snapshot Timing
Naming and Documentation
Testing and Validation
Cost Management

Security Considerations#

Data Protection
Snapshot Security
Snapshots contain complete VM data including sensitive information
Ensure proper access controls for snapshot management
Consider encryption for snapshots containing sensitive data
Monitor snapshot access and usage patterns
Compliance
Regulatory Requirements
Understand data retention requirements for your industry
Implement appropriate snapshot retention policies
Document snapshot handling procedures for audits
Ensure snapshot storage meets compliance requirements

Troubleshooting Snapshots#

Common Issues#

Creation Failures
Restoration Issues
Storage Concerns
Snapshot Creation Problems
VM State Issues: Ensure VM is in ACTIVE state
Storage Space: Verify sufficient storage quota
VM Load: Avoid snapshots during high VM activity
Account Status: Ensure account has sufficient credits
Previous
"Restoring Snapshots"
Next
"Credits System"
Built with