Barrack API Documentation
storage
Copy Page
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
GET
Delete instance
DELETE
Get instance billing
GET
Hibernate instance
POST
Reboot instance
POST
Restore hibernated instance
POST
Start instance
POST
Stop instance
POST
Toggle public IP for instance
POST
Get instance details
GET
Get hibernated instances count
GET
Add instance security rule
POST
Remove instance security rule
DELETE
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
storage
Copy Page
"Storage Management"
The Storage Management system allows you to create and manage persistent storage volumes for your virtual machines.
To check your profile completion status:
1.
Navigate to
Account Settings
2.
Verify all required fields are completed
3.
Ensure billing address is fully filled out
Volume Types
#
The platform supports different volume types for various use cases:
Standard Volumes
General-purpose storage
for data and applications
Specifications:
Minimum size:
10GB
Maximum size:
1,048,576GB (1TB)
Performance:
Optimized for GPU workloads
Persistence:
Data persists across VM lifecycles
Attachment:
Can be attached to any VM in the same region
Use cases:
Application data, databases, file storage
Bootable Volumes
Volumes containing an operating system
that can boot a VM
Specifications:
Minimum size:
100GB
Maximum size:
1,048,576GB (1TB)
Initialization:
Must have a valid OS image
Usage:
Can be used to deploy new VMs
Benefits:
Preserves installed software and configurations
Use cases:
Custom OS setups, pre-configured environments
Volume Storage Pricing
#
Volume Dashboard Statistics
#
The
Volumes page
displays key statistics for your storage in the selected region:
Total Volumes:
Number of volumes in the selected region
Total Storage:
Combined storage allocated across all volumes (in GB)
Attached Volumes:
Number of volumes currently attached to VMs
Bootable Volumes:
Number of volumes that can be used to boot VMs
Pagination and Display
#
Volume management includes efficient pagination:
6 volumes displayed per page
Previous/Next navigation with page numbers
Pagination controls appear when more than 6 volumes exist
Grid layout adjusts for desktop (3 columns) and mobile (1 column)
Volume Operations
#
Create Volumes
Add new storage volumes
Standard and bootable volume creation
Automatic naming suggestions
Real-time validation
OS image integration for bootable volumes
Manage Volumes
Attach, detach, and delete volumes
Smart VM filtering by region and status
Graceful attachment/detachment
Status validation and error handling
Multi-volume management
Volume Status Indicators
#
Volumes display status indicators to show their current state:
Storage Best Practices
#
Regional Planning
Capacity Planning
Data Management
Cost Optimization
Security & Backup
Quick Actions
#
Create Volume
Add persistent storage to your VMs
Manage Volumes
Attach, detach, and delete volumes
Best Practices
Learn storage optimization tips
Next Steps
#
1.
Create your first volume
- Start with a standard volume for data storage
2.
Learn volume management
- Master attaching and detaching volumes
3.
Explore bootable volumes
- Create reusable OS configurations
Previous
"Managing Volumes"
Next
"Creating SSH Keys"