Barrack API Documentation
  1. Instance
Barrack API Documentation
  • Platform Documentation
    • Getting Started
    • Authentication & Access
    • Account Management
    • API Keys
    • GPU Models
    • Regions
    • Instance
      • OS Images
      • Bootsource Management
      • Deploy Instance
      • Instance Management
      • Hibernation
      • View Instances
    • SSH Keys
      • Add SSH Keys
      • Manage SSH Keys
    • Volumes
      • Overview
      • Create Volume
      • List and View Volumes
      • Attach Volumes
      • Detach Volumes
      • Clone Volumes
      • Resize Volume
      • Delete Volume
    • Advanced Configurations
      • Network And Security
      • Cloudinit Script
      • Startup Script
    • Firewall
      • Manage Firewall
      • Rules and Attachment
    • Snapshot
      • Overview
      • Manage Snapshots
      • Restore Snapshots
    • Custom Images
      • Overview
      • Create and Manage Images
    • dashboard
      • "Dashboard Overview"
      • "VM Management"
    • AI Chat
      • AI Chat
  • 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 pricing information
  • Deploy Instance
    • Create a new instance
  • Instance management
    • List instances
    • Get instance details
    • Get instance billing
    • Start instance
    • Stop instance
    • Reboot instance
    • Hibernate instance
    • Restore hibernated instance
    • Toggle public IP for instance
    • Add instance security rule
    • Remove instance security rule
    • Delete instance
  • OS Images
    • List OS images
  • SSH Keys
    • List SSH keys
    • Get SSH key
    • Create SSH key
    • Delete SSH key
  • Volumes
    • List volumes
    • Create volume
    • Get volume details
    • Delete volume
    • Resize volume
    • Clone volume
    • Attach volumes to instance
    • Detach volumes from instance
    • List available volume types
    • Get volume billing
  • Firewalls
    • List firewalls
    • Get firewall details
    • Get supported protocols
    • Get firewalls attached to instance
    • List instances available for firewall attachment
    • Create firewall
    • Delete firewall
    • Add firewall rule
    • Remove firewall rule
    • Attach firewall to instances
  • Scripts
    • List all startup scripts
    • Get startup script details
    • Create a startup script
    • Update a startup script
    • Delete a startup script
    • Delete multiple startup scripts
  • Snapshots
    • List snapshots
    • Get snapshot details
    • List Instance eligible for snapshot creation
    • Get snapshot billing
    • Create snapshot
    • Delete snapshot
    • Restore snapshot
  • Images
    • List custom images
    • Get image details
    • Create image from snapshot
    • Delete custom image
    • Get snapshot-image relationship
    • Get snapshot-image relationship list
  • AI Chat
    • Get available AI models
    • Chat with AI
    • Get AI usage summary
    • Get AI usage history
  • 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. Instance

Deploy Instance

Deploy GPU-accelerated instances with custom hardware configurations and storage options.

Prerequisites#

Complete these requirements before deploying:
1
Account Authentication
Log in to your account. Unauthenticated users cannot deploy instances.
2
Complete Profile
Ensure your account profile contains:
Full name
Billing address (address line 1)
Postal code
Country
Navigate to Account Settings to complete missing information.
3
Verify Balance
Confirm sufficient account balance for hourly deployment costs. Deployments require minimum one hour of prepaid balance.

Deployment Configuration#

1. GPU Configuration#

Configure GPU model and quantity for your instance. View complete GPU specifications and selection guide.
Available GPU Models:
Advanced Regions: B300-262GB, B200-180GB, H200-141GB, H100-SXM5-80GB
Legacy Regions: H100-PCIe-NVLink-80GB, H100-PCIe-80GB, A100-PCIe-NVLink-80GB, A100-PCIe-80GB, L40, RTX-A6000
All GPU models support quantities: 1, 2, 4, or 8.

2. Region Selection#

Select the deployment region for your instance. Available regions are determined by your GPU selection.
Available Regions:
FINLAND-1 (Advanced tier)
FINLAND-2 (Advanced tier)
FINLAND-3 (Advanced tier)
ICELAND-1 (Advanced tier)
CANADA-1 (Legacy tier)

3. Boot Source#

Select how your instance will start. Complete boot source configuration guide.
Boot Source Options:
OS Images: Deploy from platform-provided operating system images
Existing Volume: Boot from existing bootable volume
Custom Image: Deploy from custom image
Configuration requirements vary by boot source type and region.
OS Volume Size (Advanced Regions):
Minimum: 100 GB
Maximum: 10,000 GB
Default: 100 GB if not specified
Type: NVMe storage

4. SSH Key Configuration#

Configure SSH access to your instance. Create new SSH keys or import existing keys if you haven't already.
SSH key requirements vary by deployment type:
Required for OS Image deployments
Required for Custom Image deployments
Not required for volume boot deployments (Advanced regions) - uses existing volume SSH configuration

5. Additional Configuration (Region-Specific)#

Advanced Regions#

Startup Scripts
Data Volumes

Legacy Regions#

Public IP Configuration
Security Rules
Cloud-Init Scripts

6. Cost Review#

Review deployment costs before launching. View current pricing.
Cost Breakdown:
Total Hourly Cost = GPU Cost + Storage Cost

Components:
- GPU: (GPU Rate × Quantity)
- OS Volume: Size-based rate (image deployments)
- Data Volumes: Size and type-based rates (if configured)
Storage costs are calculated based on volume size and type. Costs are calculated in your account's configured currency (USD, EUR, or INR).

Deployment Process#

1
Complete Configuration
Fill all required fields:
GPU model and quantity
Region
Boot source (OS image, volume, or custom image)
SSH key (if required)
Optional features (as needed)
2
Review Settings
Verify configuration accuracy:
GPU selection matches requirements
Boot source correctly configured
Storage configuration as intended
Costs within budget
3
Submit Deployment
Click "Deploy" to open deployment confirmation modal.
Instance Name Configuration:
Custom Name (Optional): Enter 3-30 characters (letters, numbers, hyphens, underscores). Cannot start or end with hyphen or underscore. Must be unique within your account and region.
Auto-Generated Name: Leave blank to auto-generate. Format: barrack-{gpu}-{random} (e.g., barrack-h100s-abc)
System performs final validation of profile completeness, balance sufficiency, stock availability, and configuration validity.
4
Deployment Execution
Platform creates instance with specified configuration. Deployment typically completes within 2-5 minutes.
5
Access Instance
Once deployed, access your instance:
Instance ID: BRK-XXXXXXVM format
IP address (if public IP enabled)
SSH access using configured key
Instance details in dashboard

Post-Deployment#

After successful deployment:
1.
Instance appears in dashboard with status "CREATING"
2.
Status updates to "ACTIVE" when fully provisioned
3.
IP address assigned (if public IP enabled)
4.
SSH access available using configured key
5.
Billing begins immediately upon deployment
6.
Email confirmation sent to account email

Validation and Errors#

Deployment validation occurs at multiple stages.

Common Validation Errors#

Profile Incomplete
Insufficient Credits
Missing Required Fields
Invalid Instance Name
Duplicate Instance Name
Out of Stock
SSH Key Not Found
Volume Not Available
SSH Key Invalid for Volume Boot

Stock Availability#

GPU stock is validated in real-time during deployment. Stock availability can change between configuration and deployment submission - the system performs final validation immediately before deployment.

API Deployment#

Deploy instances programmatically using our API. View complete endpoint documentation, authentication details, request/response schemas, and code examples in our API Reference.

Support#

Email Support
Technical assistance with deployments: [email protected]
GPU Models
Detailed GPU specifications and selection guide
Boot Source Management
Complete boot source configuration guide
Security Rules
Firewall configuration and rule management
Previous
Bootsource Management
Next
Instance Management
Built with