Barrack API Documentation
dashboard
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
dashboard
Copy Page
"VM Management"
The dashboard provides comprehensive tools for managing your virtual machines throughout their lifecycle.
Control your virtual machines with these state management options:
Power Management
VM State Controls
Start:
Power on a stopped VM
Stop:
Gracefully shut down an active VM
Reboot:
Restart an active VM
Hibernate:
Save VM state and release resources
Restore:
Resume a hibernated VM from saved state
Resource Management
VM Resource Operations
View Details:
Access comprehensive VM information
Create Volume:
Add persistent storage to VMs
Take Snapshot:
Create point-in-time backups
Delete:
Permanently remove VMs and free resources
VM State Operations
#
Power Management Operations
#
Start VM
Stop VM
Reboot VM
Power On Operations
Available for VMs in SHUTOFF or HIBERNATED state
Boot time varies by configuration and state
Billing begins when VM reaches ACTIVE state
Network connectivity restored upon startup
Use Cases:
Resume work on stopped VMs
Restore hibernated development environments
Activate scheduled or batch processing VMs
Advanced State Management
#
Hibernation Process
Restoration Process
State Transition Limitations
VM Information Display
#
The dashboard shows comprehensive information for each virtual machine:
Hardware Information
#
Compute Specifications
Storage Configuration
Network Details
Processing Resources
CPU Cores:
Number of virtual CPU cores allocated
RAM:
Total memory allocation in GB
GPU Type:
Specific GPU model and memory
GPU Count:
Number of GPUs assigned to VM
Performance Tier:
Relative performance classification
Real-time Status Information
#
VM State
Current Status
ACTIVE, SHUTOFF, HIBERNATED, or transitional states
State transition progress indicators
Last state change timestamp
Uptime and availability metrics
Resource Utilization
Usage Metrics
CPU utilization percentage
Memory usage and availability
GPU utilization metrics
Network throughput statistics
Health Monitoring
System Health
Overall VM health status
Service availability indicators
Performance alerts and warnings
System responsiveness metrics
Pricing Information Display
#
Real-time Cost Tracking
#
Current Billing Rates
Cost Breakdown
Billing State Impact
Cost Optimization Insights
#
1
Monitor Usage Patterns
Track actual VM usage vs. allocated time
Identify periods of low or no utilization
Analyze cost trends over time
Compare costs across different VM configurations
2
Identify Optimization Opportunities
Hibernation opportunities during downtime
Right-sizing opportunities for over-provisioned VMs
Alternative GPU selections for cost efficiency
Storage optimization for unused or oversized volumes
3
Implement Cost-Saving Strategies
Schedule hibernation during predictable downtime
Adjust VM configurations based on actual usage
Clean up unused resources regularly
Monitor and adjust based on changing requirements
VM Lifecycle Management
#
Creation to Deletion Workflow
#
1
VM Creation
Deployment Process
Configure VM specifications (GPU, storage, network)
Select boot source (OS image, volume, or custom image)
Configure SSH access and security settings
Deploy VM and monitor creation progress
2
Active Management
Operational Phase
Monitor VM performance and health
Manage storage volumes and attachments
Create snapshots for backup and recovery
Adjust configurations as needed
3
Maintenance Operations
Ongoing Maintenance
Apply system updates and patches
Monitor and optimize resource usage
Manage access keys and security settings
Perform regular backup operations
4
Decommissioning
End-of-Life Management
Create final backups and snapshots
Detach and preserve important volumes
Document configurations for future reference
Delete VM to free resources and stop billing
Best Practices for VM Management
#
Performance Monitoring
Cost Management
Security Management
Backup and Recovery
Multi-VM Management
#
Managing Multiple Virtual Machines
#
Fleet Overview
Multi-VM Monitoring
View status of all VMs at a glance
Compare configurations and costs
Identify optimization opportunities across fleet
Coordinate operations across multiple VMs
Batch Operations
Coordinated Management
Bulk hibernation for cost savings
Coordinated snapshot creation
Mass configuration updates
Synchronized maintenance operations
VM Organization Strategies
#
Naming Conventions
Environment Separation
Team Collaboration
Systematic VM Naming
Use descriptive names indicating purpose
Include environment indicators (dev, staging, prod)
Add project or team identifiers
Include version or iteration numbers
Examples:
ml-training-team-alpha-v2
web-api-production-us-east
dev-jupyter-john-smith
Troubleshooting VM Issues
#
Common VM Problems
#
VM Won't Start
Performance Problems
Connectivity Issues
State Transition Failures
Diagnostic Tools and Resources
#
1
Dashboard Monitoring
Use real-time status indicators in dashboard
Monitor resource utilization graphs
Check error messages and alerts
Review recent activity logs
2
VM Console Access
Access VM console for direct troubleshooting
Check system logs and error messages
Verify service status and configurations
Test network connectivity from within VM
3
Support Resources
Consult troubleshooting documentation
Contact support with detailed error information
Provide VM ID and error reproduction steps
Include relevant screenshots and log excerpts
Previous
"Dashboard Overview"
Next
"Creating Snapshots"