Barrack API Documentation
Custom Images
Copy Page
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
Get pricing information
POST
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
Custom Images
Copy Page
Create and Manage Images
Creating Images from Snapshots
#
Convert your snapshots into reusable images to quickly deploy instances with identical configurations.
Creating an Image
#
1
Navigate to Images
Go to
barrack.ai/images
Click "Create Image"
2
Select Snapshot
Choose the snapshot you want to convert to an image
If a snapshot already has an image:
You will see a warning message
The existing image name will be displayed
You must delete the existing image first
3
Enter Image Name
Provide a unique name for your image
Name Requirements:
Minimum: 3 characters
Maximum: 30 characters
Allowed characters: letters (a-z, A-Z), numbers (0-9), spaces, hyphens (-), underscores (_), dots (.)
Must be unique within your account
4
Create Image
Click "Create Image"
Image creation begins immediately
5
Wait for Completion
Image status shows as "creating"
When complete, status changes to "available"
You can now use the image to deploy instances
Image Name Requirements
#
Valid Name Examples
Invalid Name Examples
Managing Existing Images on Snapshots
#
If you attempt to create an image from a snapshot that already has an image:
Best Practices
#
Descriptive Names
Naming Strategy
Use clear, descriptive names
Include version numbers when applicable
Indicate purpose (e.g., "prod", "dev", "backup")
Avoid generic names like "image1"
Plan Before Creating
Before You Create
Verify snapshot is complete and available
Check if snapshot already has an image
Confirm you're in the correct region
Ensure profile is complete
Troubleshooting
#
Profile incomplete
No snapshots available
An image already exists for this snapshot
Image name already exists
Invalid image name
Snapshot not found
After Image Creation
#
Once your image status shows "available":
Use it to deploy new instances
Select it from the image list during instance creation
Deploy instances with identical configuration to the source snapshot
Support
#
Email Support
Image Creation Help
Contact for:
Creation errors
Snapshot availability issues
Name validation questions
Managing Snapshots
View and Manage Your Snapshots
Learn how to:
View snapshot details
Monitor storage costs
Delete unused snapshots
Organize your backups
Previous
Overview
Next
"Dashboard Overview"