Unity

Unity Fleets API

Manage server fleets

GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/projects/{projectId}/regions/{regionId}/fleets List game server fleets in a region · List Fleets #
Ask an LLM
“Which server fleets do I have running in a given region?”
“What fleets are configured for my project in this region?”
Tell an agent
List the fleets in region {regionId} for project {projectId}.
Show every game server fleet configured in region {regionId} of project {projectId}.
POST /v1/projects/{projectId}/regions/{regionId}/fleets Create a game server fleet · Create Fleet #
Ask an LLM
“How do I set up a new fleet of game servers in a region?”
“Can I configure scaling settings when I create a fleet?”
Tell an agent
Create fleet {name} in region {regionId} of project {projectId} using build configuration {buildConfiguration}.
Set up a new server fleet {name} with build configuration {buildConfiguration} and scaling {scalingSettings} in region {regionId}, project {projectId}.
GET /v1/projects/{projectId}/regions/{regionId}/fleets/{fleetId} Get a fleet's configuration and status · Get Fleet #
Ask an LLM
“What is the status of one of my game server fleets?”
“Can I check which build version a particular fleet is running?”
Tell an agent
Show fleet {fleetId} in region {regionId} of project {projectId}.
Get the status and configuration of fleet {fleetId} (project {projectId}, region {regionId}).
PATCH /v1/projects/{projectId}/regions/{regionId}/fleets/{fleetId} Update a fleet's scaling or build version · Update Fleet #
Ask an LLM
“Can I change the scaling settings on an existing fleet?”
“Is it possible to roll a fleet onto a new build version?”
Tell an agent
Update the scaling settings of fleet {fleetId} in region {regionId}, project {projectId}, to {scalingSettings}.
Switch fleet {fleetId} in project {projectId}, region {regionId}, to build configuration {buildConfiguration}.
DELETE /v1/projects/{projectId}/regions/{regionId}/fleets/{fleetId} Delete a fleet and terminate its servers · Delete Fleet #
Ask an LLM
“What happens to running servers when I delete a fleet?”
“Can I tear down a whole game server fleet at once?”
Tell an agent destructive · confirm first
Delete fleet {fleetId} in region {regionId} of project {projectId}.
Tear down fleet {fleetId} and terminate its servers in project {projectId}, region {regionId}.

Documentation

📖
Documentation
https://docs.unity.com/ugs/en-us/manual/authentication/manual/rest-api
📖
APIReference
https://services.docs.unity.com/player-auth-admin/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/cloud-code/manual
📖
APIReference
https://services.docs.unity.com/cloud-code-admin/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/cloud-save/manual/reference/rest-api
📖
APIReference
https://services.docs.unity.com/cloud-save-admin/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/economy/manual/write-configuration/rest-api
📖
APIReference
https://services.docs.unity.com/economy-admin/v2/index.html
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/leaderboards/manual/write-configuration/rest-api
📖
APIReference
https://services.docs.unity.com/leaderboards-admin/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/remote-config/manual/write-configuration/rest-api
📖
APIReference
https://services.docs.unity.com/remote-config-admin/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/analytics/manual/rest-api
📖
APIReference
https://services.docs.unity.com/analytics/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/lobby/manual/lobby-apis
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/matchmaker/manual/matchmaker-api
📖
APIReference
https://services.docs.unity.com/matchmaker-admin/v3/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/relay/manual/rest-api
📖
APIReference
https://services.docs.unity.com/relay-allocations/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/game-server-hosting/manual/api/rest-api
📖
APIReference
https://services.docs.unity.com/multiplay-config/v1/
📖
Documentation
https://docs.unity.com/ugs/manual/ccd/manual/ccd-rest-api
📖
APIReference
https://services.docs.unity.com/content-delivery-management/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/cloud-code/manual/triggers
📖
APIReference
https://services.docs.unity.com/triggers-admin/v1/
📖
APIReference
https://services.docs.unity.com/scheduler-admin/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/friends/manual/overview
📖
APIReference
https://services.docs.unity.com/friends/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/moderation/manual/overview
📖
APIReference
https://services.docs.unity.com/moderation/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/push-notifications/manual/overview
📖
Documentation
https://docs.unity.com/ugs/manual/devops/manual/build-automation/build-automation-api
📖
APIReference
https://build-api.cloud.unity3d.com/docs/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/devops/manual/unity-version-control
📖
APIReference
https://services.docs.unity.com/guides/unity-version-control-cm/overview/
📖
Documentation
https://docs.unity.com/ugs/manual/overview/manual/access-control
📖
APIReference
https://services.docs.unity.com/access/v1/
📖
Documentation
https://support.unity.com/hc/en-us/articles/38766626849684-How-do-I-configure-SCIM-provisioning
📖
APIReference
https://services.docs.unity.com/scim/v2/
📖
Documentation
https://unity.com/products/distributed-authority
📖
APIReference
https://services.docs.unity.com/distributed-authority/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/safe-text/manual/overview
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/asset-manager/manual
📖
APIReference
https://services.docs.unity.com/assets-manager/v1/
📖
Documentation
https://docs.unity.com/ads/en-us/manual/MonetizationResourceCenter
📖
APIReference
https://services.docs.unity.com/monetize/v1/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/unity/refs/heads/main/openapi/unity-fleets-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/unity:unity-fleets-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

unity-fleets-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Unity Multiplay Game Server Hosting Fleets API
  description: The Unity Multiplay Game Server Hosting REST API provides Admin endpoints for configuring and managing dedicated game server infrastructure. Supports fleet management, server allocation, build configuration, and server lifecycle management in cloud, bare metal, and hybrid hosting environments.
  version: v1.0.0
  termsOfService: https://unity.com/legal/terms-of-service
  contact:
    name: Unity Support
    url: https://support.unity.com
  license:
    name: Unity Terms of Service
    url: https://unity.com/legal/terms-of-service
servers:
- url: https://multiplay.services.api.unity.com
  description: Unity Multiplay Production Server
security:
- bearerAuth: []
tags:
- name: Fleets
  description: Manage server fleets
paths:
  /v1/projects/{projectId}/regions/{regionId}/fleets:
    get:
      operationId: listFleets
      summary: List Fleets
      description: Returns all configured server fleets for the specified project region.
      tags:
      - Fleets
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: regionId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of fleets
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FleetList'
        '401':
          description: Unauthorized
    post:
      operationId: createFleet
      summary: Create Fleet
      description: Creates a new server fleet with specified configuration and build version.
      tags:
      - Fleets
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: regionId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFleetRequest'
      responses:
        '200':
          description: Fleet created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fleet'
  /v1/projects/{projectId}/regions/{regionId}/fleets/{fleetId}:
    get:
      operationId: getFleet
      summary: Get Fleet
      description: Returns the configuration and status of a specific fleet.
      tags:
      - Fleets
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: regionId
        in: path
        required: true
        schema:
          type: string
      - name: fleetId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Fleet details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fleet'
        '404':
          description: Fleet not found
    patch:
      operationId: updateFleet
      summary: Update Fleet
      description: Updates fleet configuration including scaling settings and build version.
      tags:
      - Fleets
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: regionId
        in: path
        required: true
        schema:
          type: string
      - name: fleetId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFleetRequest'
      responses:
        '200':
          description: Fleet updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fleet'
    delete:
      operationId: deleteFleet
      summary: Delete Fleet
      description: Deletes a server fleet and terminates all associated servers.
      tags:
      - Fleets
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: regionId
        in: path
        required: true
        schema:
          type: string
      - name: fleetId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Fleet deleted
components:
  schemas:
    FleetList:
      type: object
      properties:
        fleets:
          type: array
          items:
            $ref: '#/components/schemas/Fleet'
    BuildConfiguration:
      type: object
      properties:
        buildId:
          type: integer
        commandLine:
          type: string
        queryType:
          type: string
          enum:
          - SQPQUERYTYPE
          - A2SQUERYTYPE
          - NONE
        binaryPath:
          type: string
        cores:
          type: integer
        speedMhz:
          type: integer
        memory:
          type: integer
    Fleet:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        buildConfiguration:
          $ref: '#/components/schemas/BuildConfiguration'
        scalingSettings:
          $ref: '#/components/schemas/ScalingSettings'
        status:
          type: string
          enum:
          - ACTIVE
          - OFFLINE
          - DELETED
        serverCount:
          type: integer
        freeServerCount:
          type: integer
        allocationCount:
          type: integer
        created:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
    CreateFleetRequest:
      type: object
      required:
      - name
      - buildConfiguration
      properties:
        name:
          type: string
        buildConfiguration:
          $ref: '#/components/schemas/BuildConfiguration'
        scalingSettings:
          $ref: '#/components/schemas/ScalingSettings'
    UpdateFleetRequest:
      type: object
      properties:
        name:
          type: string
        buildConfiguration:
          $ref: '#/components/schemas/BuildConfiguration'
        scalingSettings:
          $ref: '#/components/schemas/ScalingSettings'
    ScalingSettings:
      type: object
      properties:
        minFreeServers:
          type: integer
        maxFreeServers:
          type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
externalDocs:
  description: Unity Multiplay Documentation
  url: https://docs.unity.com/ugs/en-us/manual/game-server-hosting/manual/api/rest-api