Unity website screenshot

Unity

Unity is a cross-platform real-time development platform that provides a comprehensive suite of APIs and services for game development, interactive 3D content creation, and live game operations including multiplayer, analytics, economy, authentication, and DevOps tooling.

27 APIs 0 Features
Game DevelopmentReal-Time 3DMultiplayerGame ServicesCloud Gaming

APIs

Unity Player Authentication API

The Player Authentication REST API verifies player identity and manages authentication workflows, providing endpoints for sign-in, sign-up, token management, and linking externa...

Unity Cloud Code API

The Cloud Code API enables running serverless game logic in the cloud, allowing you to create, manage, and execute scripts and modules without maintaining dedicated servers. Sup...

Unity Cloud Save API

The Cloud Save REST API provides endpoints for persisting player data and game state in the cloud, with both a Player API for client-side actions and an Admin API for server-sid...

Unity Economy API

The Economy REST API allows you to manage in-game economies including virtual currencies, inventory items, purchases, and player balances through both admin and player endpoints...

Unity Leaderboards API

The Leaderboards REST API provides a Player API for submitting and fetching scores and an Admin API for creating, updating, and managing leaderboard configurations. Supports buc...

Unity Remote Config API

The Remote Config REST API enables launching new features, testing functionality, and modifying game configurations without requiring app updates, with both a Runtime API and an...

Unity Analytics API

The Analytics REST API provides endpoints for tracking player behavior, recording custom events, and querying analytics data for Unity projects. Supports custom event ingestion,...

Unity Lobby API

The Lobby REST API provides endpoints for creating, managing, and querying multiplayer game lobbies, allowing players to group together before joining a game session. Supports p...

Unity Matchmaker API

The Matchmaker REST API provides endpoints for creating and managing matchmaking tickets, defining matchmaking rules, and configuring match pools and queues for skill-based and ...

Unity Relay API

The Relay REST API provides the Relay Allocations API and QoS Discovery API, enabling peer-to-peer multiplayer connectivity without dedicated game servers through secure relay s...

Unity Multiplay Game Server Hosting API

The Multiplay Game Server Hosting REST API provides Admin API endpoints for resource configuration and a Game Server Lifecycle API for managing the lifecycle of dedicated game s...

Unity Cloud Content Delivery API

The Cloud Content Delivery (CCD) REST API enables building and releasing game updates with powerful asset management and content delivery through the cloud. Supports buckets, en...

Unity Triggers API

The Triggers API monitors a stream of internal events emitted by Unity Gaming Services and the Scheduler service, enabling Cloud Code scripts and modules to run automatically ba...

Unity Scheduler API

The Scheduler API enables scheduling events to occur at a set or recurring moment in time, which can be used to trigger Cloud Code execution on a defined schedule using cron exp...

Unity Friends API

The Friends API helps players connect with others to add a social experience to games, providing endpoints for managing friend lists, friend requests, incoming requests, and blo...

Unity Vivox Voice and Text Chat API

Vivox provides voice and text-based communication services for games, with APIs for managing channels, participants, and communication sessions across platforms. Supports 2D and...

Unity Moderation API

The Moderation API provides endpoints for actioning incidents, reviewing evidence, and monitoring community health scores to manage player behavior and content moderation across...

Unity User Generated Content API

The User Generated Content (UGC) API is a format and content-agnostic service for incorporating user-generated content features into games, handling content storage, discovery, ...

Unity Push Notifications API

The Push Notifications API allows scheduling messages to players on iOS and Android mobile devices when they are not actively playing, with support for immediate, scheduled, and...

Unity Build Automation API

The Build Automation REST API enables automating and integrating continuous integration builds into custom workflows, providing insight into build history and webhook callbacks ...

Unity Version Control API

Unity Version Control (previously Plastic SCM) provides REST API access for managing version-controlled repositories, branches, changesets, and merge requests in both cloud and ...

Unity Access API

The Access API provides endpoints for managing access control, resource policies, and permissions that control who can access, modify, or delete game data and resources across U...

Unity SCIM API

The SCIM v2 API provides a standardized protocol for automating user and group provisioning between your Identity Provider and Unity Cloud, streamlining cross-domain identity ma...

Unity Distributed Authority API

The Distributed Authority API enables decentralized multiplayer networking where game clients share responsibility for owning and tracking the state of networked objects, reduci...

Unity Safe Text API

The Safe Text API provides AI-powered text chat moderation, filtering inappropriate content and generating evidence reports for review through the Unity Moderation Platform.

Unity Asset Manager API

The Asset Manager REST API provides endpoints for uploading, managing, transforming, sharing, and accessing complex real-time 3D assets for use across Unity projects and workflows.

Unity Monetize API

The Unity Monetize API (formerly Unity Ads) provides REST endpoints for managing ad placements, revenue reporting, and monetization configuration for mobile and desktop games.

Collections

Arazzo Workflows

Unity Analytics Validate and Record

Validate an analytics event batch against the schema, then record it only when validation passes.

ARAZZO

Unity Anonymous Sign-In and Token Refresh

Sign a player in anonymously and immediately exchange the session for a refreshed access token.

ARAZZO

Unity Build Automation Trigger and Poll

Confirm a build target, start a clean build, then poll the build until it succeeds or fails.

ARAZZO

Unity Cloud Code Deploy and Run

Create a JavaScript Cloud Code script, confirm it deployed, then execute it with parameters.

ARAZZO

Unity Cloud Save Publish Public Profile

Write a server-protected stat, publish a public profile item, then read the player's data back.

ARAZZO

Unity Cloud Save Set and Query

Write player data items, query them by an indexed field, then read the full item list back.

ARAZZO

Unity Economy Grant Currency

Resolve a currency configuration, increment a player's balance, then read back the updated balances.

ARAZZO

Unity Economy Virtual Purchase

Check a player's currency balances, make a virtual purchase, then confirm the resulting inventory.

ARAZZO

Unity Friends Accept Incoming Request

List incoming friend requests, accept the first pending one, then confirm it appears in the friend list.

ARAZZO

Unity Leaderboard Provisioning

Create a leaderboard, seed it with an initial player score, then read the top scores.

ARAZZO

Unity Leaderboard Submit Score and Read Rank

Confirm a leaderboard exists, submit a player's score, then read back the player's rank.

ARAZZO

Unity Lobby Host and Query

Create a public lobby, send a keep-alive heartbeat, then confirm it is discoverable via query.

ARAZZO

Unity Lobby Join By Code

Join a private lobby by code, set the joining player's data, then heartbeat to stay active.

ARAZZO

Unity Matchmaker Queue Provisioning

Create a matchmaking queue, read it back, then list all queues to confirm it is registered.

ARAZZO

Unity Matchmaking to Server Allocation

Create a matchmaking ticket, poll until matched, then allocate a Multiplay game server for the session.

ARAZZO

Unity Matchmaking Ticket and Poll

Create a matchmaking ticket and poll its status until a match is found or matchmaking fails.

ARAZZO

Unity Multiplay Fleet Provisioning and Allocation

Register a server build, create a fleet that runs it, then allocate a server from the fleet.

ARAZZO

Unity Player Sign-Up and Identity Linking

Create a username/password player account, link an external identity, then read back the admin player record.

ARAZZO

Unity Remote Config Feature Rollout

Add a config setting, create a targeted override rule for it, then confirm the rule is listed.

ARAZZO

GraphQL

Unity Gaming Services GraphQL Schema

This conceptual GraphQL schema represents the Unity Gaming Services (UGS) platform, covering the full breadth of cloud services available to game developers. Unity Gaming Servic...

GRAPHQL

Pricing Plans

Unity Plans Pricing

1 plans

PLANS

Rate Limits

Unity Rate Limits

2 limits

RATE LIMITS

FinOps

Unity Finops

FINOPS

Semantic Vocabularies

Unity Context

8 classes · 28 properties

JSON-LD

API Governance Rules

Unity API Rules

16 rules · 7 errors 7 warnings 1 info

SPECTRAL

JSON Structure

Unity Lobby Structure

0 properties

JSON STRUCTURE

Unity Player Structure

0 properties

JSON STRUCTURE

Unity Structure

0 properties

JSON STRUCTURE

Example Payloads

Visuals

View API subway map

Resources

🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
LinkedIn
LinkedIn
🌐
Portal
Portal
🔗
Dashboard
Dashboard
📝
Signup
Signup
🟢
StatusPage
StatusPage
💬
Support
Support
📜
TermsOfService
TermsOfService
📜
PrivacyPolicy
PrivacyPolicy
📰
Blog
Blog
👥
GitHubOrganization
GitHubOrganization
🔗
APIReference
APIReference
🔗
Documentation
Documentation
🚀
GettingStarted
GettingStarted
🔑
Authentication
Authentication
🔑
Authentication
Authentication
💰
Pricing
Pricing
🔗
Forums
Forums
🔗
Community
Community
🔧
Developer Tools
Developer Tools
💬
FAQ
FAQ
💻
ErrorCodes
ErrorCodes
🔗
API Lifecycle
API Lifecycle
📄
ChangeLog
ChangeLog
🔗
Marketplace
Marketplace
🔗
Learning
Learning
🔗
SpectralRules
SpectralRules
🔗
Vocabulary
Vocabulary
🔗
JSONLDContext
JSONLDContext
🔗
LlmsText
LlmsText

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: Unity Remote Config API
  version: v1.0.0
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Config
    type: folder
  items:
  - info:
      name: List Remote Configs
      type: http
    http:
      method: GET
      url: https://remote-config.services.api.unity.com/v1/projects/:projectId/environments/:environmentId/configs
      params:
      - name: projectId
        value: ''
        type: path
      - name: environmentId
        value: ''
        type: path
    docs: Returns all configuration schemas and their settings for the specified project environment.
  - info:
      name: Get Remote Config
      type: http
    http:
      method: GET
      url: https://remote-config.services.api.unity.com/v1/projects/:projectId/environments/:environmentId/configs/:configId
      params:
      - name: projectId
        value: ''
        type: path
      - name: environmentId
        value: ''
        type: path
      - name: configId
        value: ''
        type: path
    docs: Returns a specific configuration with all its settings.
  - info:
      name: Update Remote Config
      type: http
    http:
      method: PUT
      url: https://remote-config.services.api.unity.com/v1/projects/:projectId/environments/:environmentId/configs/:configId
      params:
      - name: projectId
        value: ''
        type: path
      - name: environmentId
        value: ''
        type: path
      - name: configId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Creates or updates the complete set of settings for a configuration.
- info:
    name: Settings
    type: folder
  items:
  - info:
      name: List Config Settings
      type: http
    http:
      method: GET
      url: https://remote-config.services.api.unity.com/v1/projects/:projectId/environments/:environmentId/configs/:configId/settings
      params:
      - name: projectId
        value: ''
        type: path
      - name: environmentId
        value: ''
        type: path
      - name: configId
        value: ''
        type: path
    docs: Returns all settings (key-value pairs) in the configuration.
  - info:
      name: Add Config Setting
      type: http
    http:
      method: POST
      url: https://remote-config.services.api.unity.com/v1/projects/:projectId/environments/:environmentId/configs/:configId/settings
      params:
      - name: projectId
        value: ''
        type: path
      - name: environmentId
        value: ''
        type: path
      - name: configId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Adds a new key-value setting to the configuration.
- info:
    name: Override Rules
    type: folder
  items:
  - info:
      name: List Override Rules
      type: http
    http:
      method: GET
      url: https://remote-config.services.api.unity.com/v1/projects/:projectId/environments/:environmentId/rules
      params:
      - name: projectId
        value: ''
        type: path
      - name: environmentId
        value: ''
        type: path
    docs: Returns all override rules for the environment. Rules target specific player segments with configuration overrides.
  - info:
      name: Create Override Rule
      type: http
    http:
      method: POST
      url: https://remote-config.services.api.unity.com/v1/projects/:projectId/environments/:environmentId/rules
      params:
      - name: projectId
        value: ''
        type: path
      - name: environmentId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Creates a new override rule targeting a specific player segment with custom configuration values.
  - info:
      name: Update Override Rule
      type: http
    http:
      method: PUT
      url: https://remote-config.services.api.unity.com/v1/projects/:projectId/environments/:environmentId/rules/:ruleId
      params:
      - name: projectId
        value: ''
        type: path
      - name: environmentId
        value: ''
        type: path
      - name: ruleId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Updates an existing override rule's conditions or settings.
  - info:
      name: Delete Override Rule
      type: http
    http:
      method: DELETE
      url: https://remote-config.services.api.unity.com/v1/projects/:projectId/environments/:environmentId/rules/:ruleId
      params:
      - name: projectId
        value: ''
        type: path
      - name: environmentId
        value: ''
        type: path
      - name: ruleId
        value: ''
        type: path
    docs: Deletes a targeting override rule.
bundled: true