Documentation

​
​

Development

User Acquisition

Monetization

Industry

Unity Services Web APIs

Open Unity Dashboard

Unity Services Web APIs

​
​
Unity Services Web APIs
  • Overview
  • Get started
Web API guides
  • Authentication
  • API lifecycle
  • Response status and error codes
  • Response headers
  • Unity Version Control CM API
  • Unity Version Control server API
Admin Settings
  • Access
  • Unity Releases
Analytics
  • Analytics
Identity and Access Management
  • Application and Deep Linking
Monetization
  • Monetize
Viewers and Collaboration
  • Annotations
  • Presence
Access
  • Access
Assets
  • Assets
Auth
  • Auth
Collaboration
  • Collaboration
Content Management
  • DataStreaming
  • Storage
  • Workflow Engine
DevOps
  • Automation
  • Build Automation
  • Unity Version Control
Growth
  • Ads Unified Platform
  • User Acquisition
Identity
  • SCIM
In-App Purchases
  • Webshop
Live Operations
  • Game Backend
  • Observability Logs
Multiplayer
  • Distributed Authority
  • Friends
  • Lobby
  • Matchmaker
  • Player Names
  • QoS Discovery
  • Relay Allocations
  • Session Observability
  • Vivox Voice and Text Chat
Unity
  • Projects and Apps
Unity Pipeline
  • Asset Pipeline
  1. Unity Services Web APIs

API Lifecycle

Learn about Unity's API versioning conventions and deprecation policy.
Read time 1 minute
Last updated a month ago

API Versioning

Our API endpoints are versioned and typically structured in the following format:
<BASE_URL>/<VERSION>/<API_NAMESPACE>/<...>
where 
<VERSION>
is the version number of the API (example: v1).
The API may receive non-breaking changes without its version number being changed.
Breaking changes are introduced only to new API versions.
Non-breaking changes can include (but are not limited to):
  • Adding new optional request headers
  • Adding new fields to the response
  • Adding new status codes to the response status codes list
  • Changing a required field to be optional
  • Changes to rate limits
  • Under-the-hood fixes that don't change the URL signature, the request format or the response format
Breaking changes can include (but are not limited to):
  • Changing the URL signature
  • Removing a field from the response
  • Adding a new required field to the request

Deprecation Policy

If a newer version of the API is released or if the service is discontinued, the API or one of its versions may be deprecated and eventually shutdown. When deprecating an API, Unity will update the documentation in this portal by indicating deprecated routes and providing alternative solutions for the deprecated endpoints.
After three months to a year of continued support for a deprecated version, Unity may cease support or shutdown that version entirely. A version shutdown notice will be posted in this portal at least 2 months in advance.
Copyright © 2026 Unity Technologies
LegalPrivacy PolicyCookiesDocumentation Terms of UseDo Not Sell or Share My Personal InformationYour Privacy Choices (Cookie Settings)

"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S and elsewhere (more info here). Other names or brands are trademarks of their respective owners.

Some pages are machine-translated for convenience, and may contain inaccuracies. In the event of conflicting information, the English version is authoritative.

  • On this page

    • API Versioning

    • Deprecation Policy