Unity

Unity Servers API

Manage individual server instances

Documentation GitHub OpenAPI

Documentation

https://docs.unity.com/ugs/en-us/manual/authentication/manual/rest-api

https://services.docs.unity.com/player-auth-admin/v1/

https://docs.unity.com/ugs/en-us/manual/cloud-code/manual

https://services.docs.unity.com/cloud-code-admin/v1/

https://docs.unity.com/ugs/en-us/manual/cloud-save/manual/reference/rest-api

https://services.docs.unity.com/cloud-save-admin/v1/

https://docs.unity.com/ugs/en-us/manual/economy/manual/write-configuration/rest-api

https://services.docs.unity.com/economy-admin/v2/index.html

https://docs.unity.com/ugs/en-us/manual/leaderboards/manual/write-configuration/rest-api

https://services.docs.unity.com/leaderboards-admin/v1/

https://docs.unity.com/ugs/en-us/manual/remote-config/manual/write-configuration/rest-api

https://services.docs.unity.com/remote-config-admin/v1/

https://docs.unity.com/ugs/en-us/manual/analytics/manual/rest-api

https://services.docs.unity.com/analytics/v1/

https://docs.unity.com/ugs/en-us/manual/lobby/manual/lobby-apis

https://docs.unity.com/ugs/en-us/manual/matchmaker/manual/matchmaker-api

https://services.docs.unity.com/matchmaker-admin/v3/

https://docs.unity.com/ugs/en-us/manual/relay/manual/rest-api

https://services.docs.unity.com/relay-allocations/v1/

https://docs.unity.com/ugs/en-us/manual/game-server-hosting/manual/api/rest-api

https://services.docs.unity.com/multiplay-config/v1/

https://docs.unity.com/ugs/manual/ccd/manual/ccd-rest-api

https://services.docs.unity.com/content-delivery-management/v1/

https://docs.unity.com/ugs/en-us/manual/cloud-code/manual/triggers

https://services.docs.unity.com/triggers-admin/v1/

https://services.docs.unity.com/scheduler-admin/v1/

https://docs.unity.com/ugs/en-us/manual/friends/manual/overview

https://services.docs.unity.com/friends/v1/

https://docs.unity.com/ugs/en-us/manual/moderation/manual/overview

https://services.docs.unity.com/moderation/v1/

https://docs.unity.com/ugs/en-us/manual/push-notifications/manual/overview

https://docs.unity.com/ugs/manual/devops/manual/build-automation/build-automation-api

https://build-api.cloud.unity3d.com/docs/

https://docs.unity.com/ugs/en-us/manual/devops/manual/unity-version-control

https://services.docs.unity.com/guides/unity-version-control-cm/overview/

https://docs.unity.com/ugs/manual/overview/manual/access-control

https://services.docs.unity.com/access/v1/

https://support.unity.com/hc/en-us/articles/38766626849684-How-do-I-configure-SCIM-provisioning

https://services.docs.unity.com/scim/v2/

https://unity.com/products/distributed-authority

https://services.docs.unity.com/distributed-authority/v1/

https://docs.unity.com/ugs/en-us/manual/safe-text/manual/overview

https://docs.unity.com/ugs/en-us/manual/asset-manager/manual

https://services.docs.unity.com/assets-manager/v1/

https://docs.unity.com/ads/en-us/manual/MonetizationResourceCenter

https://services.docs.unity.com/monetize/v1/

Specifications

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

Other Resources

https://raw.githubusercontent.com/api-evangelist/unity/refs/heads/main/graphql/unity-graphql.md

OpenAPI Specification

openapi: 3.0.1
info:
  title: Unity Analytics Allocations Servers API
  description: The Unity Analytics REST API provides endpoints for ingesting custom analytics events from game clients and servers. Events are used to track player behavior, game performance, and feature adoption. The API supports batched event ingestion with automatic retry and buffering for high-volume game telemetry.
  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://analytics.services.api.unity.com
  description: Unity Analytics Production Server
security:
- apiKeyAuth: []
tags:
- name: Servers
  description: Manage individual server instances
paths:
  /v1/projects/{projectId}/regions/{regionId}/fleets/{fleetId}/servers:
    get:
      operationId: listServers
      summary: List Servers
      description: Returns all server instances in the specified fleet.
      tags:
      - Servers
      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: List of servers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerList'
components:
  schemas:
    Server:
      type: object
      properties:
        id:
          type: integer
        ip:
          type: string
        port:
          type: integer
        queryPort:
          type: integer
        status:
          type: string
          enum:
          - ONLINE
          - ALLOCATED
          - OFFLINE
        machineID:
          type: integer
        created:
          type: string
          format: date-time
    ServerList:
      type: object
      properties:
        servers:
          type: array
          items:
            $ref: '#/components/schemas/Server'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
externalDocs:
  description: Unity Analytics Documentation
  url: https://docs.unity.com/ugs/en-us/manual/analytics/manual/rest-api