LogoLogo
edgegap.comDashboard
  • 📘Learning Center
    • Getting Started
    • Unity Games
      • Getting Started - Servers
      • Developer Tools
    • Unreal Engine Games
      • Getting Started - Servers
      • Developer Tools
    • Matchmaking
      • Getting Started
      • Matchmaker In-Depth
      • Ping Beacons
    • Advanced Features
      • Apps and Versions
      • Deployments
      • Managed Clusters
  • API Reference
    • Dedicated Servers
    • Integration
    • Matchmaking
    • Peer to Peer
  • Release Notes
  • 📚Documentation
    • Sample Projects
      • Unity Netcodes
        • Unity NGO
        • Photon Fusion 1
        • Photon Fusion 2
        • Mirror
        • Mirror WebGL
        • Fishnet
        • Fishnet WebGL
        • Photon Bolt
      • Unreal Top-Down Sample
      • NuxtJS
      • Ruby On Rails
      • Unity Lobbies
      • Unity Matchmaker
    • Tools & Integrations
      • Container
        • What is Docker
        • Your First Docker
        • The Good Practices
        • SSH in Your Container
        • External Registries
          • Docker Hub
          • AWS ECR
          • GCP GCR
          • Gitlab registry
      • Deploy from Nakama
      • EOS Lobby Integration
      • Switch From Gamelift
      • Switch From Multiplay
      • Playfab Bridge
    • Deployment
      • Endpoint Storage
        • How to Save Logs
        • Upload File to Deployment
      • Webhooks
    • Application
      • Command and Arguments
      • 1:1 Port Mapping
    • Session
      • How They Work
      • Application Version Configuration
      • Manage Request
      • Selectors Filtering
    • Fleet
      • Fleet Policy
      • Policy Filter
      • Linking Version
      • Fleet's Deployment
    • Container Registry
    • Distributed Relay
      • Matchmaker/Lobby
      • Relay Edgegap API
      • Transport Samples
    • Lobby
      • Lobby Service
      • Functions
    • Glossary
    • SLA Terms
Powered by GitBook
LogoLogo

Connect with Community

  • Discord
  • Linkedin
  • X

Read More

  • Release Notes
  • Blog
  • Enterprise
  • Legal
  • edgegap.com

© 2025 Edgegap

On this page
  • What Are the Fleets
  • What It Does?
  • How it helps?
  • How to Create a Fleet
  • With the API

Was this helpful?

  1. Documentation

Fleet

PreviousSelectors FilteringNextFleet Policy

Last updated 2 months ago

Was this helpful?

We recommend reading and .

Fleets are currently only supported with session-based deployment.

What Are the Fleets

A fleet is a tool to facilitate the creation of session-based deployments. It automatically creates deployments worldwide based on simple but powerful settings. This way, you can ensure that you have at least what you need regarding server capacity. It can also delete them fully automatically with some more in-depth configuration. We will soon see how to create your first fleet.

What It Does?

  • Automatically creates a new deployment when a certain capacity threshold is reached on the currently running deployments.

  • Allows always to have a minimum number of deployments ready to receive sessions.

  • It makes it possible to set a maximum number of simultaneous deployments.

  • It is bound to a region, so it allows controlling the number of servers running in a given region at any time.

How it helps?

Below are a few examples of how it can be helpful to you:

  • It can save you money. By setting a maximum number of deployments, along with an acceptable threshold, you can be sure that a new deployment will be made only when necessary and only up to the maximum number set.

  • It can improve the user's experience. The threshold allows you to control the server capacity and the number of sessions it can handle. Take a survival game, for example. Some people might prefer very crowded servers, while others would prefer a less intense experience. With a lower threshold, you could make sure a new server spawns whenever the last one reaches its capacity limit, so players can choose a more or less populated server according to their preferences.

  • It makes your life easier. Once properly configured, along with a reasonable empty time to live, the deployments will be created and terminated automatically as users join and leave the servers, and you won't even have to think about it! Simply connect and disconnect the sessions, and there will always be the optimal number of servers ready.

How to Create a Fleet

We will now create your first fleet with examples from the dashboard and the API. Feel free to choose your favorite way to do it, but using the dashboard at least once may help you understand the structure of the fleets.

In our example, we will create a fleet to manage our deployments in the North American continent. Note that the name will not filter your deployment location. For that, we will add policies in the next section.

With the Dashboard

Once created, you will be redirected to the detail page of your new fleet.

With the API

{
  "name": "na-fleet",
  "enabled": false
}

Name: The name of your fleet. It must be unique.

Enabled: If your fleet is enabled or not. We strongly recommend only enabling your fleet when it's completely configured. If not, the fleet might automatically create deployments that you do not want.

That's all for the creation of the fleet itself! Of course, we will need to do a bit more to make our fleet work correctly. That's what we will do in the next section.

📚
Comparing Deployment and Session Approaches for Game Server Management
How Sessions Work
API Reference