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

"Authentication & Access"

Multiple secure ways to access your account and manage your GPU-accelerated virtual machines.
We provide several authentication options to ensure secure and convenient access to your account:
Email & Password
Traditional login with your registered email and password
Features:
Secure password-based authentication
Password recovery available via email
Strong password requirements
Login at: barrack.ai/login
OTP Login
Secure one-time password login via email
Features:
Enhanced security with temporary codes
No password storage required
Email verification for each login
Automatic code expiration
Google OAuth
Quick sign-in with your Google account
Features:
Single sign-on convenience
No additional password required
Leverages Google's security infrastructure
Instant account access
Password Recovery
Email-based password reset with secure verification
Features:
Secure recovery process
Email verification required
New password setup
Account security notifications

Login Process#

Email & Password Login#

1
Access Login Page
Navigate to barrack.ai/login
2
Enter Credentials
Enter your registered email address
Enter your secure password
Optional: Check "Remember me" for convenience
3
Verify Identity
Complete any additional security verification if prompted
4
Access Dashboard
Successfully log in to your dashboard

OTP (One-Time Password) Login#

1
Request OTP
Navigate to login page
Click "Login with OTP"
Enter your registered email address
2
Check Email
Check your email inbox for the OTP code
The code is valid for 10 minutes
Codes are single-use only
3
Enter OTP
Return to the login page
Enter the 6-digit OTP code
Click "Verify and Login"
4
Access Account
Successfully access your account with enhanced security

Google OAuth Login#

1
Initiate OAuth
Navigate to login page
Click "Continue with Google"
You'll be redirected to Google's authentication
2
Google Authentication
Log in to your Google account if not already logged in
Review and accept the permissions requested
Authorize Barrack to access your basic profile information
3
Return to Platform
You'll be automatically redirected back to Barrack
Your account will be created or accessed automatically
Access your dashboard immediately

Account Creation#

New Account Registration#

1
Access Registration
Navigate to barrack.ai/signup
2
Choose Registration Method
Email Registration: Create account with email and password
Google OAuth: Register using your Google account
Both methods provide the same platform access
3
Provide Required Information
Valid email address (for communications)
Secure password (if using email registration)
Accept terms of service and privacy policy
4
Verify Email
Check your email for verification message
Click the verification link to activate your account
Email verification is required for account security
5
Complete Profile
Access your account page
Complete billing information (required for purchases)
Add contact information and preferences

Profile Completion Requirements#

To use platform features that require payment, complete your profile with:
Personal Information
Billing Address
Payment Settings
Full Name: Legal name for billing purposes
Email Address: Primary contact (cannot be changed after registration)
Phone Number: Optional but recommended for account recovery

Password Recovery Process#

If you forget your password or need to reset it:
1
Access Recovery
Go to the login page
Click "Forgot Password?" link
Enter your registered email address
2
Check Email
Check your email for the password reset link
The link is valid for 24 hours
Click the secure reset link provided
3
Create New Password
Enter a new secure password
Confirm the new password
Ensure it meets all security requirements
4
Confirm Reset
Complete the password reset process
Log in with your new password
Update any saved password managers

Security Best Practices#

Password Requirements#

When creating or updating your password, ensure it meets these security requirements:
Minimum Requirements
Recommended Practices
Avoid These
Length: At least 8 characters
Uppercase: At least 1 uppercase letter (A-Z)
Lowercase: At least 1 lowercase letter (a-z)
Numbers: At least 1 numeric digit (0-9)
Special Characters: At least 1 special character (!@#$%^&*)

Troubleshooting Authentication Issues#

Common Login Problems#

Forgotten Password
Email Not Received
OAuth Issues
Account Locked
Problem: Can't remember your password
Solution:
1.
Use the "Forgot Password?" link on login page
2.
Enter your registered email address
3.
Check email for reset instructions
4.
Follow the secure reset process
5.
Create a new, strong password

Account Support#

If you continue to experience authentication issues:
Email Support
Contact our support team
Include in your message:
Your registered email address
Description of the issue
Steps you've already tried
Any error messages received
Account Recovery
For serious account issues
Our team can help with:
Account recovery assistance
Email address changes
Security concern resolution
Identity verification
Next
"Getting Started"
Built with