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

"Attaching Firewalls to VMs"

Firewalls must be attached to VMs to take effect. You can manage these attachments through the firewall management interface.
To attach a firewall to a virtual machine:
1
Access Attachment Interface
From the firewall card, click the "Attach" button
2
Select Target VM
Select a VM from the list of available machines:
Only VMs with ACTIVE status are displayed
VMs that have server_uuid are eligible for attachment
Single VM selection using radio button interface
Already attached VMs are marked with checkmark icon
3
Confirm Attachment
Click "Attach Firewall" to confirm the attachment
4
Monitor Attachment Status
Wait for attachment to complete and verify success

VM Compatibility Requirements#

Eligible Virtual Machines#

VM Status Requirements
Active VM Needed
VM must be in ACTIVE state to attach firewall
VM must have a valid server_uuid
VMs in HIBERNATED or STOPPED state cannot be attached
VM must be fully operational and responsive
Technical Requirements
System Prerequisites
VM networking must be properly configured
VM must be accessible through management interface
Network infrastructure must support firewall attachment
No conflicting security configurations

VM State Validation#

Supported States
Unsupported States
Error States
Attachment-Ready States
ACTIVE
VM is running and fully operational
All services are available
Network connectivity is established
Ready for firewall attachment

Multi-Firewall Attachments#

Multiple Firewalls per VM#

Firewall Stacking
Rule Interaction
Management Strategy

Firewall Organization Strategies#

Application-Layer Organization
Environment-Based Organization
Functional Separation
Web Tier Firewall:
HTTP/HTTPS traffic rules
Load balancer configurations
CDN and proxy rules
Application Tier Firewall:
API access rules
Inter-service communication
Database connection rules
Management Firewall:
SSH access rules
Monitoring and logging
Administrative interfaces

Viewing Firewall Attachments#

To view and manage firewall attachments:
1
Access Firewall Details
Click "View Details" on any firewall card
2
Navigate to Attachments
Select the "Attached VMs" tab in the firewall details interface
3
Review Attachment Information
View comprehensive attachment details:
VM Name and identification
VM Status (ACTIVE, HIBERNATED, etc.)
Attachment Status (SUCCESS, ATTACHING, ERROR)
Attachment timestamp and duration
4
Manage Attachments
Use available controls to detach or modify attachments as needed

Attachment Status Types#

Attachment Information Display#

The attachment interface provides detailed information for management:

VM Information Table#

Basic VM Details
Status Information
Attachment Metadata
Essential Information
VM Name: User-defined virtual machine identifier
VM ID: System-generated unique identifier
Region: Geographic location of the VM
Creation Date: When the VM was originally created

Detaching Firewalls#

To remove firewall protection from a VM:
1
Access Detachment Interface
Navigate to firewall details and locate the attached VM
2
Initiate Detachment
Click the detach button for the specific VM
3
Confirm Detachment
Review the detachment warning and confirm the action
4
Monitor Detachment
Wait for detachment to complete and verify removal

Detachment Considerations#

Security Impact
Service Continuity
Alternative Protection

Attachment Best Practices#

Planning Firewall Attachments#

1
Assess Security Requirements
Identify network traffic patterns and requirements
Determine necessary ports and protocols
Plan for different security layers and functions
Consider compliance and regulatory requirements
2
Design Firewall Architecture
Plan firewall organization and rule distribution
Consider performance impact of multiple firewalls
Design for scalability and maintainability
Document firewall purposes and interactions
3
Test Attachment Strategy
Test firewall attachments in development environment
Validate application functionality with firewalls attached
Monitor performance impact of firewall rules
Test failover and disaster recovery scenarios
4
Implement and Monitor
Attach firewalls during maintenance windows
Monitor application performance and connectivity
Validate security effectiveness
Document operational procedures

Operational Best Practices#

Attachment Timing
When to Attach Firewalls
Attach firewalls before VM goes into production
Use maintenance windows for production changes
Coordinate with application deployment schedules
Plan for testing and validation time
Monitoring and Validation
Post-Attachment Monitoring
Monitor application performance after attachment
Validate that required traffic is allowed
Check that unauthorized traffic is blocked
Monitor firewall logs for security events

Troubleshooting Attachment Issues#

Common Attachment Problems#

VM Not Eligible
Attachment Fails
Attachment Shows Error

Debugging Attachment Issues#

1
Check VM Status
Verify VM is in ACTIVE state
Confirm VM has valid server_uuid
Test VM responsiveness and connectivity
Check for any VM error conditions
2
Validate Firewall Configuration
Review firewall rules for conflicts
Check firewall status and health
Verify firewall is in SUCCESS state
Test firewall functionality with other VMs
3
Test Network Connectivity
Test VM network connectivity before and after attachment
Verify DNS resolution and internet connectivity
Check for blocked connections in firewall logs
Validate application-specific connectivity requirements
4
Contact Support if Needed
Provide VM ID and firewall ID
Include error messages and timestamps
Describe attempted troubleshooting steps
Include network configuration details
Previous
"Managing SSH Keys"
Next
"Firewall Management"
Built with