Barrack API Documentation
  1. dashboard
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
  1. dashboard

"Dashboard Overview"

The Dashboard provides a comprehensive overview of your virtual machines, account information, and quick access to platform features.
The dashboard is organized into three main sections for optimal workflow:
Instance Details
Left Panel
Selected VM overview and specifications
Hardware details (CPU, Memory, Storage, GPU)
Network information (Private/Public IPs)
Real-time status indicators
Quick action buttons
VM Operations
Center Panel
VM selector dropdown
VM configuration controls
Status control actions (Start, Stop, Hibernate)
Management operations (Delete, Snapshot)
Pricing information
Account & Actions
Right Panel
Account information and Barrack ID
Credit balance and billing details
GST/VAT information management
Quick navigation actions
Logout functionality

Key Dashboard Features#

Real-time Monitoring#

VM Status Tracking
Resource Monitoring
Cost Tracking

Quick Actions#

Access frequently used platform features directly from the dashboard:
VM Management
Virtual Machine Operations
Deploy VM - Create new virtual machines
Start, stop, and hibernate existing VMs
Create snapshots for backup
Delete VMs when no longer needed
Resource Management
Storage and Infrastructure
SSH Keys - Manage secure access
Volumes - Create and manage storage
Snapshots - Backup and recovery
Security and firewall configuration

VM Information Display#

The dashboard shows comprehensive information for each virtual machine:

Hardware Specifications#

Compute Resources
Storage Configuration
Network Configuration
Processing Power
CPU Cores: Number of virtual CPU cores
RAM: Total memory allocation in GB
GPU Type: Specific GPU model and count
GPU Memory: GPU memory allocation
Performance Tier: Relative performance rating

Pricing Information#

Current Costs
Real-time Billing
Cost per hour for current configuration
Cost per minute for precise tracking
Current billing state (ACTIVE, HIBERNATED, etc.)
Projected daily and monthly costs
Billing Details
Cost Breakdown
GPU costs (primary cost component)
Storage costs for attached volumes
Network costs (if applicable)
Total cost calculation

VM Selector and Management#

VM Selection Interface#

1
VM Dropdown
Use the VM selector dropdown to quickly switch between multiple virtual machines
2
Automatic Update
The dashboard automatically updates to show details for the selected VM
3
Real-time Sync
All panels update simultaneously with current VM information
4
Persistent Selection
Your selected VM remains active across dashboard refreshes

Multi-VM Management#

VM Comparison
Batch Operations
Fleet Monitoring

Account Information Panel#

Account Details#

Basic Information
Billing Information
Usage Statistics
Account Identification
Barrack ID: Unique account identifier
Account Email: Primary contact email
Account Type: Individual or organization
Registration Date: Account creation date

Credit Balance Monitoring#

Balance Tracking
Current Financial Status
Real-time credit balance display
Low balance warnings and alerts
Spending rate calculation
Projected balance duration
Usage Insights
Spending Analysis
Daily and hourly spending patterns
Cost breakdown by resource type
Optimization recommendations
Budget planning assistance

Navigation and Quick Actions#

Platform Navigation#

Access key platform features directly from the dashboard:
Resource Management
Account Management
Monitoring and Analytics

Quick Action Benefits#

1
Streamlined Workflow
Reduce clicks and navigation time with direct action access
2
Contextual Actions
Actions are relevant to current VM selection and state
3
Consistent Interface
Familiar interface across all platform features
4
Rapid Operations
Perform common tasks without leaving the dashboard

Dashboard Customization#

Layout Preferences#

Display Options
Customize View
Panel arrangement preferences
Information density settings
Refresh rate configuration
Theme and color preferences
Notification Settings
Alert Configuration
Status change notifications
Cost threshold alerts
Performance warnings
Maintenance notifications

Performance Optimization#

Auto-refresh Settings
Data Loading

Mobile and Responsive Design#

Cross-Device Compatibility#

Desktop Experience
Tablet Experience
Mobile Experience
Full-Featured Interface
Three-panel layout with full information display
Comprehensive controls and detailed metrics
Multi-monitor support
Keyboard shortcuts for power users

Dashboard Best Practices#

Monitoring Efficiency#

1
Regular Check-ins
Monitor VM status and costs daily
Review resource utilization weekly
Analyze spending patterns monthly
Plan capacity changes quarterly
2
Proactive Management
Set up cost alerts for budget management
Monitor performance trends
Plan for scaling needs
Optimize resource allocation
3
Cost Optimization
Use hibernation for unused VMs
Right-size VMs based on actual usage
Clean up unused resources regularly
Monitor and adjust storage allocation

Security Monitoring#

Access Monitoring
Resource Security
Previous
"Firewall Rules"
Next
"VM Management"
Built with