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

"Account Management"

Your account profile contains essential information for using the platform and processing payments.
Update your basic personal details in your account settings:
Basic Details
Required Information
Name: Full name (required, letters, spaces, hyphens, apostrophes only, 2-100 characters)
Email: Your registered email address (cannot be changed after registration)
Phone Number: Optional contact number (international format supported)
Contact Preferences
Communication Settings
Primary Email: Used for all platform communications
Phone Notifications: Optional SMS alerts for important events
Marketing Preferences: Control promotional communications

Name Requirements#

Email Address Management#

Email Restrictions
Email Verification

Billing Address#

Complete your billing address to enable payments on the platform:
Required Fields
Optional Fields
Validation Rules
Mandatory Information
Address Line: Street address, apartment, suite, etc. (required, max 255 characters)
Postal Code: Postal or ZIP code (required, alphanumeric with hyphens/spaces)
Country: Select your country from the dropdown list (required)

Address Formatting Guidelines#

1
Street Address
Enter your complete street address including:
House/building number
Street name
Apartment/suite number (if applicable)
Any additional location identifiers
2
Geographic Information
Provide accurate geographic details:
Correct city name
State or province (where applicable)
Accurate postal/ZIP code
Select correct country from dropdown
3
Validation
Ensure all information is accurate:
Double-check spelling of all fields
Verify postal code format for your country
Confirm country selection matches your location
Review for completeness before saving

Payment Information#

Your country selection automatically determines the currency used for all transactions:
Indian Rupee (₹)
India-based Accounts
Country: India
Currency: Indian Rupee (₹)
Tax: GST at 18% applied
Payment Methods: UPI, cards, net banking
Euro (€)
European Countries
Countries: EU member states and select European countries
Currency: Euro (€)
Tax: VAT may apply based on local regulations
Payment Methods: Credit card, SEPA transfers
US Dollar ($)
All Other Countries
Countries: United States and most other countries
Currency: US Dollar ($)
Tax: Generally no additional taxes
Payment Methods: Credit card, debit card

Currency Assignment Rules#

Automatic Currency Selection
Tax Implications
Payment Processing

Profile Completion#

The system tracks whether your profile has all required information:

Completion Status#

Complete Profile
Ready for Platform Use
All required fields completed
Billing address information provided
Payment processing enabled
Full platform access available
Incomplete Profile
Requires Additional Information
Missing required billing information
Cannot purchase credits or create paid resources
Limited platform functionality
Profile completion required for full access

Required for Completion#

Benefits of Complete Profile#

1
Payment Processing
Enable credit purchases and resource billing
2
Resource Creation
Create volumes, snapshots, and other paid resources
3
Full Platform Access
Access all features and capabilities
4
Support Services
Receive prioritized customer support

Form Validation#

Input validation requirements ensure data quality and security:

Field-Specific Validation#

Name Validation
Phone Validation
Address Validation
Full Name Requirements
Character Set: Only letters, spaces, hyphens, and apostrophes
Length: Between 2 and 100 characters
Required: Cannot be empty
Format: Proper name format expected
Examples: "John Smith", "Mary-Jane O'Connor", "José García"

Real-time Validation#

Immediate Feedback
Error Prevention
Success Indicators

Account Security#

Security Best Practices#

1
Strong Password
Use a unique, complex password
Include uppercase, lowercase, numbers, and symbols
Avoid personal information or common words
Change password regularly
2
Email Security
Keep email account secure with strong password
Enable two-factor authentication on email if available
Monitor for suspicious login attempts
Keep email address current and accessible
3
Account Monitoring
Review account activity regularly
Monitor credit usage and spending patterns
Check for unauthorized access or changes
Report suspicious activity immediately
4
Information Protection
Keep billing information current and accurate
Protect account credentials from sharing
Use secure networks for account access
Log out from shared computers

Privacy and Data Protection#

Data Security
Information Protection
All personal data encrypted in transit and at rest
Secure data centers with physical security
Limited access to personal information
Regular security audits and updates
Privacy Compliance
Regulatory Compliance
GDPR compliance for European users
Privacy regulations followed based on location
Data retention policies clearly defined
User rights respected and protected

Account Support#

Getting Help#

Email Support
General Account Help
Contact for:
Profile completion assistance
Billing address questions
Payment processing issues
General account inquiries
Technical Support
Technical Issues
Contact for:
Platform access problems
Form validation errors
Account functionality issues
Security concerns

Support Information to Include#

Account Information
Error Information
Profile Issues
Previous
"Credits System"
Next
Get credit balance
Built with