Unity Queues API

Configure matchmaking queues and pools

Operations 5

GET /v3/projects/{projectId}/environments/{environmentId}/queues List Matchmaking Queues #
POST /v3/projects/{projectId}/environments/{environmentId}/queues Create Matchmaking Queue #
GET /v3/projects/{projectId}/environments/{environmentId}/queues/{queueName} Get Matchmaking Queue #
PUT /v3/projects/{projectId}/environments/{environmentId}/queues/{queueName} Update Matchmaking Queue #
DELETE /v3/projects/{projectId}/environments/{environmentId}/queues/{queueName} Delete Matchmaking Queue #

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

Other Resources

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-queues-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.

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

OpenAPI Specification

unity-queues-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Unity Matchmaker Queues API
  description: The Unity Matchmaker REST API provides endpoints for creating and managing matchmaking tickets, defining matchmaking rules, and configuring match pools and queues. It enables skill-based and attribute-based player matching with low latency for games of all sizes.
  version: v3.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://matchmaker.services.api.unity.com
  description: Unity Matchmaker Production Server
security:
- bearerAuth: []
tags:
- name: Queues
  description: Configure matchmaking queues and pools
paths:
  /v3/projects/{projectId}/environments/{environmentId}/queues:
    get:
      operationId: listQueues
      summary: List Matchmaking Queues
      description: Returns all configured matchmaking queues for the environment.
      tags:
      - Queues
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: environmentId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of queues
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueueList'
    post:
      operationId: createQueue
      summary: Create Matchmaking Queue
      description: Creates a new matchmaking queue with specified rules and pool configuration.
      tags:
      - Queues
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: environmentId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateQueueRequest'
      responses:
        '200':
          description: Queue created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Queue'
  /v3/projects/{projectId}/environments/{environmentId}/queues/{queueName}:
    get:
      operationId: getQueue
      summary: Get Matchmaking Queue
      description: Returns configuration and status for a specific matchmaking queue.
      tags:
      - Queues
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: environmentId
        in: path
        required: true
        schema:
          type: string
      - name: queueName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Queue details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Queue'
        '404':
          description: Queue not found
    put:
      operationId: updateQueue
      summary: Update Matchmaking Queue
      description: Updates the configuration of an existing matchmaking queue.
      tags:
      - Queues
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: environmentId
        in: path
        required: true
        schema:
          type: string
      - name: queueName
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateQueueRequest'
      responses:
        '200':
          description: Queue updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Queue'
    delete:
      operationId: deleteQueue
      summary: Delete Matchmaking Queue
      description: Deletes a matchmaking queue and all its configuration.
      tags:
      - Queues
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: environmentId
        in: path
        required: true
        schema:
          type: string
      - name: queueName
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Queue deleted
components:
  schemas:
    CreateQueueRequest:
      type: object
      required:
      - name
      properties:
        name:
          type: string
        enabled:
          type: boolean
          default: true
        defaultEscalationRules:
          $ref: '#/components/schemas/EscalationRules'
        pools:
          type: array
          items:
            $ref: '#/components/schemas/Pool'
    EscalationRules:
      type: object
      properties:
        timeoutSeconds:
          type: integer
        backfillEnabled:
          type: boolean
    Pool:
      type: object
      properties:
        name:
          type: string
        maximumPlayerCount:
          type: integer
        minimumPlayerCount:
          type: integer
        matchLogic:
          $ref: '#/components/schemas/MatchLogic'
    UpdateQueueRequest:
      type: object
      properties:
        enabled:
          type: boolean
        defaultEscalationRules:
          $ref: '#/components/schemas/EscalationRules'
        pools:
          type: array
          items:
            $ref: '#/components/schemas/Pool'
    Queue:
      type: object
      properties:
        name:
          type: string
        enabled:
          type: boolean
        defaultEscalationRules:
          $ref: '#/components/schemas/EscalationRules'
        pools:
          type: array
          items:
            $ref: '#/components/schemas/Pool'
        created:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
    MatchLogic:
      type: object
      properties:
        name:
          type: string
        script:
          type: string
          description: MMScript for match rules
    QueueList:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/Queue'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
externalDocs:
  description: Unity Matchmaker Documentation
  url: https://docs.unity.com/ugs/en-us/manual/matchmaker/manual/matchmaker-api