Barrack API Documentation
Platform Documentation
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
Platform Documentation
Copy Page
"Troubleshooting"
This section provides solutions to common issues you may encounter when using the platform.
VM Deployment Issues
#
Insufficient Credits
#
If you receive an "Insufficient Credits" error during deployment:
1
Check Current Balance
Navigate to your
account page
to check your current credit balance
2
Purchase Additional Credits
Add credits to your account through the account page payment section
3
Verify Minimum Requirements
Ensure you meet minimum balance requirements:
USD: $1.00
EUR: €1.00
INR: ₹100.00
4
Retry Deployment
Return to the
deployment page
and try again
Resource Availability
#
If your selected GPU type or count is unavailable in the region:
Region Alternative
GPU Alternative
Timing Strategy
Try Different Regions
Switch to NORWAY-1, CANADA-1, or US-1
Check availability in multiple regions
Consider latency impact of region choice
All regions offer the same GPU types
SSH Connection Failures
#
If you can't connect to your VM via SSH:
VM Status Verification
SSH Key Validation
Username and Connection
Network and Firewall
SSH Connection Command Reference
#
Firewall Issues
#
Rule Not Taking Effect
#
If your firewall rules aren't working as expected:
1
Wait for Propagation
Rules may take up to 10 minutes to fully apply after creation or modification
2
Verify Rule Configuration
Check the rule configuration:
Correct protocol (TCP, UDP, ICMP)
Proper port ranges
Accurate IP address ranges in CIDR notation
Correct direction (Ingress/Egress)
3
Check Firewall Attachment
Ensure the firewall is properly attached to the VM:
Verify attachment in firewall management
Check VM status is ACTIVE
Confirm firewall is in SUCCESS state
4
Test Connectivity
Test the specific connection:
Use telnet to test port connectivity
Check application logs for connection attempts
Verify from both source and destination
Cannot Delete Firewall
#
If you're unable to delete a firewall:
Detach First
Standard Procedure
Detach the firewall from all VMs first
Verify no active attachments remain
Check attachment status in firewall details
Wait for detachment to complete
Force Delete
Alternative Method
Use force delete option if available
Contact support for stuck firewalls
Check for hidden or failed attachments
Verify firewall is not in transitional state
Volume Issues
#
Volume Attachment Failures
#
If you can't attach a volume to a VM:
VM Status Check
Regional Compatibility
Volume Status
System Limitations
Verify VM Readiness
Ensure VM is in ACTIVE state
Check VM is not undergoing other operations
Verify VM has completed initial setup
Ensure VM is not hibernated or suspended
Volume Detachment Issues
#
If you can't detach a volume:
VM State Requirements
Boot Volume Protection
Application Dependencies
Volume Creation Problems
#
If you're having trouble creating a volume:
1
Size Validation
Verify you have entered a valid size:
Standard volumes: minimum 10GB
Bootable volumes: minimum 100GB
Maximum size: 1,048,576GB (1TB)
Size must be a positive integer
2
Name Uniqueness
Ensure you're using a unique volume name:
Check existing volumes in all regions
Volume names must be unique across your account
Use descriptive, meaningful names
Follow naming conventions (letters, numbers, spaces, hyphens, underscores, periods)
3
OS Image Selection
For bootable volumes, confirm you've selected a valid OS image:
Choose from available images in your region
Verify image compatibility with volume size
Check regional image availability
Ensure image is not deprecated or unavailable
4
Account Requirements
Check that you have sufficient credits for storage allocation:
Verify minimum credit balance
Ensure account profile is complete
Check payment method validity
Review storage cost implications
Snapshot and Image Issues
#
Snapshot Creation Failure
#
If you're unable to create a snapshot:
VM Prerequisites
VM Requirements
Verify the VM is in ACTIVE state
Ensure VM has sufficient disk space
Check VM is not under heavy load
Wait for any ongoing operations to complete
Account Validation
Account Requirements
Ensure you have a unique name for the snapshot
Check sufficient credits for snapshot storage
Verify account profile is complete
Ensure no naming conflicts exist
Image Creation Issues
#
If you're having trouble creating an image:
Source Snapshot Validation
Naming and Resources
Account and Billing Issues
#
Can't Purchase Credits
#
If you can't buy credits:
1
Complete Profile
Ensure your account profile is fully completed:
Full name and contact information
Complete billing address
Postal code and country selection
Phone number (recommended)
2
Payment Method
Verify your payment method:
Check card details and expiration
Ensure sufficient funds available
Try alternative payment methods
Check with your bank for restrictions
3
Minimum Purchase
Meet minimum purchase requirements:
USD: $5 minimum
EUR: €5 minimum
INR: ₹100 minimum
4
Geographic Restrictions
Check for any geographic payment restrictions:
Verify supported countries for payments
Check local banking regulations
Consider alternative payment methods
Contact support for assistance
Profile Not Complete
#
Make sure you have all required information:
Personal Information
Billing Address
Validation Steps
Required Fields
Full legal name
Valid email address (primary contact)
Phone number (optional but recommended)
Verify email address is confirmed
SSH Key Management Issues
#
Key Import Failures
#
If you can't import an SSH key:
Key Format Validation
Common Format Issues
Naming Issues
Key Creation Problems
#
If automatic key generation fails:
1
Browser Compatibility
Check browser compatibility and settings:
Ensure JavaScript is enabled
Disable popup blockers temporarily
Try a different browser
Clear browser cache and cookies
2
Download Issues
If private key download fails:
Check browser download settings
Verify sufficient disk space
Try right-click "Save as" if auto-download fails
Check antivirus software interference
3
Alternative Generation
Generate keys manually if needed:
Use ssh-keygen on local machine
Import the generated public key
Follow local key generation best practices
Ensure proper key permissions
Getting Support
#
If you're experiencing issues that aren't resolved by the troubleshooting steps above:
Email Support
Contact our support team
Response time: Usually within 24 hours
Include in your message:
Account email address
Detailed description of the issue
Steps you've already tried
Error messages or screenshots
Deployment ID or VM ID if applicable
Urgent Issues
For critical problems
Mark subject as "Urgent Issue"
For issues like:
Service outages
Data loss concerns
Security incidents
Billing discrepancies
Support Checklist
#
When contacting support, include this information for faster resolution:
Account Information
Issue Details
Resource Information
Troubleshooting
Account email address
Date and time when issue occurred
Your timezone for scheduling
Account ID or username if different from email
Common Error Codes
#
Understanding error codes can help you troubleshoot issues more effectively:
Authentication Errors
Resource Errors
Network Errors
Storage Errors
Previous
"Platform Documentation"
Next
"Advanced Configuration"