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

"Getting Started"

Get up and running with your first virtual machine in just a few steps.
Recommended setup process:
1
Create an Account
Create an account using email/password or Google OAuth for quick access to the platform.
Sign up at: barrack.ai/signup
2
Complete Your Profile
Navigate to My Account section and complete your profile with billing information (required for payments).
Required information:
Full name
Complete address
Postal code
Country (determines currency)
3
Add Credits
Purchase credits to pay for your virtual machines and storage.
Minimum amounts:
USD: $1.00
EUR: €1.00
INR: ₹100.00
4
Deploy Your VM
Use the Deploy VM page to create your SSH key and launch your virtual machine.

Authentication & Access#

Multiple ways to access your account:
Email & Password
Traditional login with your registered email and password
Secure authentication
Password recovery available
Login at barrack.ai/login
OTP Login
Secure one-time password login via email
Enhanced security
No password required
Email verification
Google OAuth
Quick sign-in with your Google account
Single sign-on
No additional password
Instant access
Password Recovery
Email-based password reset with secure verification
Secure recovery process
Email verification
New password setup

Prerequisites Checklist#

Before deploying your first VM, ensure you have:
Profile Requirements
Account Balance
Security Setup
Planning
Complete Profile - Billing information must be filled out
Valid Address - Street address, city, postal code
Country Selection - Determines your billing currency
Contact Information - Phone number (optional but recommended)

SSH Connection Guide#

Step 1: SSH Key Creation (On Deploy Page)#

SSH keys are created on the deployment page at barrack.ai/deploy:
1.
Go to barrack.ai/deploy
2.
Find the SSH key creation option on the deploy page
3.
Create a new SSH key (manual step - not automatic)
4.
Download starts - key saved to Downloads folder
5.
File format: barrack_[keyname].pem

Step 2: Get Your Public IP#

If Public IP enabled during deployment:
Find your VM in dashboard
Copy the Public IP (format: 185.x.x.x)
If Public IP not enabled:
Go to dashboard → Click VM "Details"
Enable "Public IP" → Wait 1-2 minutes → Copy new IP

Step 3: Connect via SSH#

Windows (Command Prompt/PowerShell):
cd C:\Users\%USERNAME%\Downloads
ssh -i "barrack_[your-key-name].pem" ubuntu@[YOUR_PUBLIC_IP]
Example:
ssh -i "barrack_private_key.pem" ubuntu@185.216.21.177
Mac/Linux:

Quick Deployment Guide#

1. Choose Your GPU#

Select from our high-performance GPU options:
GPU ModelPerformance LevelBest ForPrice (USD/hour)
H100-SXM5-80GBHighestLarge language models, complex AI research$2.69
H100-PCIe-NVLink-80GBVery HighMulti-GPU workloads, distributed training$2.29
H100-PCIe-80GBVery HighSingle-GPU inference, model training$2.25
A100-SXM4-80GB-NVLinkHighDeep learning, scientific computing$1.59
A100-PCIe-80GBHighML training, data analytics$1.55
L40Medium-HighAI inference, graphics workloads$1.19
RTX-A6000MediumDevelopment, small-scale training$0.69
A40MediumProfessional graphics, AI development$0.69

2. Select Region#

Choose the geographic location closest to your users:
NORWAY-1
Europe Region
Low latency for European users
All GPU types available
CANADA-1
North America Region
Optimized for North American users
All GPU types available
US-1
United States Region
US-based infrastructure
All GPU types available

3. Configure Boot Source#

Choose from multiple boot source options:
OS Images
Volumes
Custom Images
Pre-configured operating systems optimized for GPU workloads
Available images:
Ubuntu Server 22.04 LTS R550 CUDA 12.4
Ubuntu Server 22.04 LTS R550 CUDA 12.4 with Docker
Ubuntu Server 20.04 LTS R535 CUDA 12.2
Ubuntu Server 20.04 LTS R535 CUDA 12.2 with Docker

Post-Deployment Steps#

Once your VM is deployed:
1
Connect via SSH
Use your private key to securely connect to your VM
ssh -i "barrack_[your-key-name].pem" ubuntu@[YOUR_PUBLIC_IP]
2
Configure Firewall Rules
Set up network security rules for your specific needs
Create firewall rules
Attach firewalls to VMs
3
Create Storage Volumes
Add persistent storage for your data and applications
Create volumes
Manage volumes
4
Take Snapshots
Create backups for recovery and replication
Create snapshots
Manage snapshots
Previous
"Authentication & Access"
Next
"Platform Documentation"
Built with