Unity Builds API

Manage and trigger builds

Operations 7

GET /orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds Get Builds #
POST /orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds Start Build #
GET /orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number} Get Build #
DELETE /orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number} Cancel Build #
GET /v1/projects/{projectId}/builds List Builds #
POST /v1/projects/{projectId}/builds Create Build #
GET /v1/projects/{projectId}/builds/{buildId} Get Build #

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-builds-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-builds-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Unity Builds API
  version: v1.0.0
  contact:
    name: Unity Support
    url: https://support.unity.com
  license:
    name: Unity Terms of Service
    url: https://unity.com/legal/terms-of-service
  termsOfService: https://unity.com/legal/terms-of-service
  description: 'Operations tagged Builds across 2 of this provider''s published API definitions: unity-build-automation-openapi.yml, unity-multiplay-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://build-api.cloud.unity3d.com/api/v1
  description: Unity Build Automation API Server
- url: https://multiplay.services.api.unity.com
  description: Unity Multiplay Production Server
tags:
- name: Builds
  description: Manage and trigger builds
paths:
  /orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds:
    get:
      operationId: getBuilds
      summary: Get Builds
      description: Returns the build history for a build target.
      tags:
      - Builds
      parameters:
      - name: orgid
        in: path
        required: true
        schema:
          type: string
      - name: projectid
        in: path
        required: true
        schema:
          type: string
      - name: buildtargetid
        in: path
        required: true
        schema:
          type: string
      - name: per_page
        in: query
        required: false
        schema:
          type: integer
          default: 25
      - name: page
        in: query
        required: false
        schema:
          type: integer
          default: 1
      responses:
        '200':
          description: Build history
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Build'
      security:
      - basicAuth: []
    post:
      operationId: startBuild
      summary: Start Build
      description: Triggers a new build for the specified build target.
      tags:
      - Builds
      parameters:
      - name: orgid
        in: path
        required: true
        schema:
          type: string
      - name: projectid
        in: path
        required: true
        schema:
          type: string
      - name: buildtargetid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartBuildRequest'
      responses:
        '202':
          description: Build started
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Build'
      security:
      - basicAuth: []
    servers:
    - url: https://build-api.cloud.unity3d.com/api/v1
      description: Unity Build Automation API Server
  /orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}:
    get:
      operationId: getBuild
      summary: Get Build
      description: Returns details for a specific build including status, artifacts, and logs.
      tags:
      - Builds
      parameters:
      - name: orgid
        in: path
        required: true
        schema:
          type: string
      - name: projectid
        in: path
        required: true
        schema:
          type: string
      - name: buildtargetid
        in: path
        required: true
        schema:
          type: string
      - name: number
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Build details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Build'
      security:
      - basicAuth: []
    delete:
      operationId: cancelBuild
      summary: Cancel Build
      description: Cancels an in-progress build.
      tags:
      - Builds
      parameters:
      - name: orgid
        in: path
        required: true
        schema:
          type: string
      - name: projectid
        in: path
        required: true
        schema:
          type: string
      - name: buildtargetid
        in: path
        required: true
        schema:
          type: string
      - name: number
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Build cancelled
      security:
      - basicAuth: []
    servers:
    - url: https://build-api.cloud.unity3d.com/api/v1
      description: Unity Build Automation API Server
  /v1/projects/{projectId}/builds:
    get:
      operationId: listBuilds
      summary: List Builds
      description: Returns all game server builds for the project.
      tags:
      - Builds
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of builds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildList'
      security:
      - bearerAuth: []
    post:
      operationId: createBuild
      summary: Create Build
      description: Creates a new game server build configuration.
      tags:
      - Builds
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBuildRequest'
      responses:
        '200':
          description: Build created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Build_2'
      security:
      - bearerAuth: []
    servers:
    - url: https://multiplay.services.api.unity.com
      description: Unity Multiplay Production Server
  /v1/projects/{projectId}/builds/{buildId}:
    get:
      operationId: getBuild
      summary: Get Build
      description: Returns details of a specific game server build.
      tags:
      - Builds
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: buildId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Build details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Build_2'
      security:
      - bearerAuth: []
    servers:
    - url: https://multiplay.services.api.unity.com
      description: Unity Multiplay Production Server
components:
  schemas:
    Build:
      type: object
      properties:
        build:
          type: integer
        buildtargetid:
          type: string
        buildTargetName:
          type: string
        platform:
          type: string
        status:
          type: string
          enum:
          - queued
          - sentToBuilder
          - started
          - restarted
          - success
          - failure
          - canceled
          - unknown
        changeset:
          type: array
          items:
            type: object
            properties:
              commitId:
                type: string
              message:
                type: string
              timestamp:
                type: string
                format: date-time
        artifacts:
          type: array
          items:
            $ref: '#/components/schemas/BuildArtifact'
        created:
          type: string
          format: date-time
        finished:
          type: string
          format: date-time
        duration:
          type: integer
    StartBuildRequest:
      type: object
      properties:
        clean:
          type: boolean
          description: Whether to start a clean build
        delay:
          type: integer
          description: Seconds to delay before starting
    BuildArtifact:
      type: object
      properties:
        key:
          type: string
        name:
          type: string
        primary:
          type: boolean
        show_download:
          type: boolean
        links:
          type: object
          properties:
            href:
              type: string
    Build_2:
      type: object
      properties:
        id:
          type: integer
        buildID:
          type: integer
        buildName:
          type: string
        os:
          type: string
          enum:
          - LINUX
          - WINDOWS
        created:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
    BuildList:
      type: object
      properties:
        builds:
          type: array
          items:
            $ref: '#/components/schemas/Build_2'
    CreateBuildRequest:
      type: object
      required:
      - buildName
      - os
      properties:
        buildName:
          type: string
        os:
          type: string
          enum:
          - LINUX
          - WINDOWS
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- unity-build-automation-openapi.yml
- unity-multiplay-openapi.yml