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

"Firewall Management"

The Firewall Management system allows you to create and configure network security rules to protect your virtual machines. Maximum limit: 25 firewalls per account.
The Firewall page displays your existing firewalls with detailed information (6 firewalls per page):
Firewall Information
Displayed Details
Firewall name and description
Status indicator (SUCCESS, CREATING, ERROR)
Region information
Creation date
Rule count
Attached VM count
Management Actions
Available Operations
View Details
Add Rule
Attach to VMs
Delete
Real-time status monitoring

Dashboard Statistics#

The firewall management interface provides comprehensive statistics:
Firewall Metrics
System Overview
Total Firewalls: Number of firewalls in your account
Total Rules: Combined rules across all firewalls
Attachments: Total VM attachments across firewalls
Active Firewalls: Firewalls currently protecting VMs
Status Distribution
Operational Status
SUCCESS: Fully operational firewalls
CREATING: Firewalls being set up
ERROR: Firewalls with configuration issues
Regional Distribution: Firewalls by region

Creating Firewalls#

To create a new firewall:
1
Access Creation
Click the "Create Firewall" button (disabled when limit reached)
2
Configure Basic Information
Enter firewall details:
Firewall name (required, maximum 50 characters)
Description (optional, maximum 255 characters)
Region selection from dropdown
3
Create Firewall
Click "Create Firewall" to initialize the new firewall
4
Configure Rules
After creation, add security rules to define traffic policies

Firewall Naming Requirements#

Regional Considerations#

Region Selection
Cross-Region Management

Firewall Lifecycle#

Creation Process#

Planning Phase
Creation Phase
Configuration Phase
Before Creating Firewalls
Identify security requirements for your applications
Map network traffic patterns and dependencies
Determine required ports and protocols
Plan for different environments (dev, staging, prod)

Firewall States#

Firewall Limits and Quotas#

Account Limitations#

Firewall Limits
Quantity Restrictions
Maximum: 25 firewalls per account
Regional Distribution: No per-region limits
Rule Limits: Varies by firewall complexity
Attachment Limits: Multiple VMs per firewall
Resource Management
Efficient Usage
Plan firewall usage across projects
Reuse firewalls for similar applications
Delete unused firewalls to free quota
Group related rules in single firewalls

Best Practices for Limits#

Firewall Consolidation
Quota Management

Firewall Information Display#

Detailed Firewall Information#

Each firewall displays comprehensive details:
Basic Information
Configuration Summary
Operational Metrics
Essential Details
Name: User-defined firewall identifier
Description: Optional purpose description
Region: Geographic deployment location
Status: Current operational state
Creation Date: When firewall was created

Security Rules Timing#

Rule Application Process#

1
Rule Creation
New rules are validated and saved to firewall configuration
2
Configuration Propagation
Rules are distributed to network infrastructure (up to 10 minutes)
3
Traffic Filtering
Rules become active and begin filtering network traffic
4
Monitoring and Validation
Test connectivity and validate rule effectiveness

Firewall Management Best Practices#

Security Design Principles#

Defense in Depth
Principle of Least Privilege
Documentation and Compliance

Operational Best Practices#

1
Planning and Design
Map application network requirements before creating rules
Design firewall architecture for scalability
Plan for different environments and use cases
Consider compliance and regulatory requirements
2
Implementation
Start with restrictive rules and open access gradually
Test rules in development environment first
Document all rules with clear descriptions
Implement changes during maintenance windows
3
Monitoring and Maintenance
Monitor firewall effectiveness and performance
Regular security audits and rule reviews
Update rules based on changing requirements
Remove obsolete or unused rules promptly
4
Incident Response
Plan for security incident response procedures
Maintain emergency access procedures
Document escalation and communication procedures
Regular disaster recovery testing

Firewall Integration#

Integration with VM Workflow#

VM Deployment
Deployment Integration
Attach firewalls during VM creation
Configure security rules before going live
Test connectivity after deployment
Monitor security effectiveness
Application Deployment
Application Integration
Configure rules for specific applications
Plan for application update requirements
Test application functionality with firewall rules
Monitor application performance impact

Automation and Scaling#

Automated Rule Management
Scaling Considerations

Common Firewall Scenarios#

Web Application
Database Server
Development Environment
Production Environment
Web Server Firewall
Purpose: Protect web servers and applications
Common Rules: HTTP (80), HTTPS (443), SSH (22)
Considerations: Load balancer integration, CDN compatibility
Monitoring: Web application performance and security metrics
Previous
"Attaching Firewalls to VMs"
Next
"Firewall Rules"
Built with