Build Automation Client API • Unity Docs

List all xcode versions

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "List all xcode versions"

orgid

string

required

No description

projectid

string

required

No description

HTTP response status codes for "List all xcode versions":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "List all xcode versions":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/versions/xcode"

Response example

[ { "hidden": true, "deprecated": true, "name": "John Doe", "value": "example-value" }]

List all visual studio versions for UWP applications

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "List all visual studio versions for UWP applications"

orgid

string

required

No description

projectid

string

required

No description

HTTP response status codes for "List all visual studio versions for UWP applications":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "List all visual studio versions for UWP applications":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/versions/visual-studio"

Response example

[ { "visual_studio_version": "2024", "windows_sdk_versions": [ "10.0.17134.0", "10.0.17763.0", "10.0.18362.0" ] }]

Get the currently authenticated user.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

HTTP response status codes for "Get the currently authenticated user.":

Ok

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get the currently authenticated user.":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/users/me"

Response example

{ "email": "julie.smith@example.org", "name": "Julie Smith", "unityid": "0000000", "waiting": false, "permissions": [ "string" ], "lastAcceptedEulaVersion": "string", "disableNotifications": false, "orgs": [ { "name": "string", "id": "string", "foreign_key": "string" } ], "links": {}}

Update the current user's information specific to the Unity Build Automation service.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Request body for "Update the current user's information specific to the Unity Build Automation service."

Media Type:

application/json

disableNotifications

boolean

example: false

When true build status email notifications will no longer be sent

lastAcceptedEulaVersion

string

example: 1.0.0

Last accepted EULA version

HTTP response status codes for "Update the current user's information specific to the Unity Build Automation service.":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Update the current user's information specific to the Unity Build Automation service.":

Request example

curl -X PUT \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: application/json" \ -d '{ "disableNotifications": false, "lastAcceptedEulaVersion": "1.0.0"}' \ "https://build-automation.services.api.unity.com/v2/users/me"

Response example

{ "email": "julie.smith@example.org", "name": "Julie Smith", "unityid": "0000000", "waiting": false, "permissions": [ "string" ], "lastAcceptedEulaVersion": "string", "disableNotifications": false, "orgs": [ { "name": "string", "id": "string", "foreign_key": "string" } ], "links": {}}

List all iOS device profiles for the current user

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

HTTP response status codes for "List all iOS device profiles for the current user":

Ok

4XX

Client Side Error

5XX

Server Side Error

Code samples for "List all iOS device profiles for the current user":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/users/me/devices"

Response example

[ { "udid": "1234567890abcdef1234567890abcdef12345678", "devicename": "iPhone 12", "os": "Android", "osversion": "14.0", "product": "iPhone", "status": "disabled" }]

Create a new iOS device profile for the current user

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Request body for "Create a new iOS device profile for the current user"

Media Type:

application/json

udid

string

example: 1234567890abcdef1234567890abcdef12345678

device unique identifier

devicename

string

example: iPhone 12

device name

os

string

Device operating system (Android or iOS)

osversion

string

example: 14.0

operating system version

product

string

example: iPhone

product

status

string

Device status.

HTTP response status codes for "Create a new iOS device profile for the current user":

Created

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Create a new iOS device profile for the current user":

Request example

curl -X POST \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: application/json" \ -d '{ "udid": "1234567890abcdef1234567890abcdef12345678", "devicename": "iPhone 12", "os": "Android", "osversion": "14.0", "product": "iPhone", "status": "disabled"}' \ "https://build-automation.services.api.unity.com/v2/users/me/devices"

Response example

{ "udid": "1234567890abcdef1234567890abcdef12345678", "devicename": "iPhone 12", "os": "Android", "osversion": "14.0", "product": "iPhone", "status": "disabled"}

Get a unity version by value

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get a unity version by value"

orgid

string

required

No description

projectid

string

required

No description

unityVersionValue

string

required

No description

HTTP response status codes for "Get a unity version by value":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get a unity version by value":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/versions/unity/{unityVersionValue}"

Response example

{ "name": "John Doe", "value": "example-value", "xcode_versions": [ "xcode13_2_1", "xcode14_0" ], "hidden": true, "deprecated": true, "cloudRenderingEnabled": true, "entitledPlatformsSupported": [ "ios", "android", "webgl" ], "architectures": [ "AppleIntel", "AppleSilicon" ], "isBuildProfileSupported": true}

List all SCM types supporting auto detecting the project Unity version

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "List all SCM types supporting auto detecting the project Unity version"

orgid

string

required

No description

projectid

string

required

No description

HTTP response status codes for "List all SCM types supporting auto detecting the project Unity version":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "List all SCM types supporting auto detecting the project Unity version":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/versions/auto_detect_supported_scms"

Response example

[ "git", "svn"]

List all unity versions

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "List all unity versions"

orgid

string

required

No description

projectid

string

required

No description

Query parameters for "List all unity versions"

platform

string

No description

HTTP response status codes for "List all unity versions":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "List all unity versions":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/versions/unity"

Response example

[ { "name": "Unity 2022.3.0f1", "value": "2022.3.0f1", "hidden": false, "deprecated": false, "cloudRenderingEnabled": true, "isBuildProfileSupported": true, "xcode_versions": [ "xcode14_0", "xcode15_0" ], "entitledPlatformsSupported": [ "ios", "android" ], "architectures": [ "arm64", "x86_64" ] }]

Get Build Automation Status

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

HTTP response status codes for "Get Build Automation Status":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get Build Automation Status":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/status"

Response example

[ { "text": "This platform is not actively supported anymore and will be removed soon", "platform": "webplayer", "priority": 1, "billingPlan": "Personal", "scmType": "git", "alertType": "info", "autoClear": false, "redirect": "https://example.com/redirect" }]

Check a url for connectivity

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Check a url for connectivity"

orgid

string

required

No description

projectid

string

required

No description

Request body for "Check a url for connectivity"

Media Type:

application/json

type

string

required

Source control management (SCM) system type. Values: 'git', 'svn', 'p4' (Perforce), 'oauth', or 'plastic' (UVCS)

url

string

required

example: https://github.com/unity/example-repo.git

No description

user

string

example: johndoe

No description

pass

string

example: secret123

No description

fingerprint

string

example: a1b2c3d4e5f6g7h8i9j0

No description

p4authtype

string

example: p4-ticket-12345

Deprecated p4-specific auth type - please use authType instead

authType

string

Authentication type for Perforce or Plastic SCM. Perforce: 'ticket' or 'password' Plastic: 'UPWorkingMode', 'LDAPWorkingMode', or 'SSOWorkingMode'

plasticAccessToken

string

example: plastic_token_123

No description

plasticEnvironment

string

Plastic SCM environment. Values: 'prd' (production) or 'stg' (staging)

shallowclone

boolean

example: true

No description

windowsGitBinary

string

Windows Git binary type. - cygwin: Use Cygwin version of git - native: Use native Windows version of git

useEncryption

boolean

example: false

No description

encryptionKey

string

example: a1b2c3d4e5f6g7h8i9j0

No description

encryptionMethod

string

Plastic SCM encryption method. Values: 'AES128', 'AES192', or 'AES256' (Advanced Encryption Standard with key size)

oauth

object

OAuth configuration for SCM providers

scm_provider

string

example: scm_provider

No description

temp_state

string

example: temp_state

No description

github

object

Base OAuth provider settings (shared by GitHub, GitLab, Bitbucket, and extended by Azure OAuth)

repository

object

The OAuth-connected repository that a project is bound to. Mirrors the

OAuthRepository

subdocument in

src/shared/models/scm.ts

.

owner

object

Owner of an OAuth-connected repository. The concrete shape varies per SCM provider (GitHub, GitLab, Bitbucket, Azure DevOps), so only the fields that are relied on by the dashboard are exposed here; provider-specific extras are intentionally dropped to keep the response contract stable.

clone_url

string

example: https://github.com/unity/example.git

No description

archived_clone_url

string

example: https://github.com/unity/example.git

No description

forks

integer

example: 0

No description

watchers

integer

example: 0

No description

full_name

string

example: unity/example

No description

name

string

example: example

No description

scm

string

example: git

No description

provider_id

string

example: gh-1234

No description

token

string

example: token

No description

refreshToken

string

example: refreshToken

No description

expiration

string

example: 2025-12-31T23:59:59.000Z

No description

expirationInterval

integer

example: 0

No description

gitlab

object

Base OAuth provider settings (shared by GitHub, GitLab, Bitbucket, and extended by Azure OAuth)

repository

object

The OAuth-connected repository that a project is bound to. Mirrors the

OAuthRepository

subdocument in

src/shared/models/scm.ts

.

owner

object

Owner of an OAuth-connected repository. The concrete shape varies per SCM provider (GitHub, GitLab, Bitbucket, Azure DevOps), so only the fields that are relied on by the dashboard are exposed here; provider-specific extras are intentionally dropped to keep the response contract stable.

clone_url

string

example: https://github.com/unity/example.git

No description

archived_clone_url

string

example: https://github.com/unity/example.git

No description

forks

integer

example: 0

No description

watchers

integer

example: 0

No description

full_name

string

example: unity/example

No description

name

string

example: example

No description

scm

string

example: git

No description

provider_id

string

example: gh-1234

No description

token

string

example: token

No description

refreshToken

string

example: refreshToken

No description

expiration

string

example: 2025-12-31T23:59:59.000Z

No description

expirationInterval

integer

example: 0

No description

bitbucket

object

Bitbucket OAuth configuration (extends base OAuth provider settings)

repository

object

The OAuth-connected repository that a project is bound to. Mirrors the

OAuthRepository

subdocument in

src/shared/models/scm.ts

.

owner

object

Owner of an OAuth-connected repository. The concrete shape varies per SCM provider (GitHub, GitLab, Bitbucket, Azure DevOps), so only the fields that are relied on by the dashboard are exposed here; provider-specific extras are intentionally dropped to keep the response contract stable.

clone_url

string

example: https://github.com/unity/example.git

No description

archived_clone_url

string

example: https://github.com/unity/example.git

No description

forks

integer

example: 0

No description

watchers

integer

example: 0

No description

full_name

string

example: unity/example

No description

name

string

example: example

No description

scm

string

example: git

No description

provider_id

string

example: gh-1234

No description

token

string

example: token

No description

refreshToken

string

example: refreshToken

No description

expiration

string

example: 2025-12-31T23:59:59.000Z

No description

expirationInterval

integer

example: 0

No description

workspace

string

example: my-workspace

No description

azure

object

Azure OAuth configuration (extends base OAuth provider settings)

repository

object

The OAuth-connected repository that a project is bound to. Mirrors the

OAuthRepository

subdocument in

src/shared/models/scm.ts

.

owner

object

Owner of an OAuth-connected repository. The concrete shape varies per SCM provider (GitHub, GitLab, Bitbucket, Azure DevOps), so only the fields that are relied on by the dashboard are exposed here; provider-specific extras are intentionally dropped to keep the response contract stable.

clone_url

string

example: https://github.com/unity/example.git

No description

archived_clone_url

string

example: https://github.com/unity/example.git

No description

forks

integer

example: 0

No description

watchers

integer

example: 0

No description

full_name

string

example: unity/example

No description

name

string

example: example

No description

scm

string

example: git

No description

provider_id

string

example: gh-1234

No description

token

string

example: token

No description

refreshToken

string

example: refreshToken

No description

expiration

string

example: 2025-12-31T23:59:59.000Z

No description

expirationInterval

integer

example: 0

No description

azureOrg

string

required

example: azureOrg

No description

azureProject

string

required

example: azureProject

No description

HTTP response status codes for "Check a url for connectivity":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Check a url for connectivity":

Request example

curl -X POST \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: application/json" \ -d '{ "type": "git", "url": "https://github.com/unity/example-repo.git", "user": "johndoe", "pass": "secret123", "fingerprint": "a1b2c3d4e5f6g7h8i9j0", "p4authtype": "p4-ticket-12345", "authType": "UPWorkingMode", "plasticAccessToken": "plastic_token_123", "plasticEnvironment": "prd", "shallowclone": true, "windowsGitBinary": "cygwin", "useEncryption": false, "encryptionKey": "a1b2c3d4e5f6g7h8i9j0", "encryptionMethod": "AES128", "oauth": { "scm_provider": "scm_provider", "temp_state": "temp_state", "github": { "repository": { "owner": { "login": "unity", "name": "Unity", "avatar_url": "https://github.com/unity.png", "html_url": "https://github.com/unity" }, "clone_url": "https://github.com/unity/example.git", "archived_clone_url": "https://github.com/unity/example.git", "forks": 0, "watchers": 0, "full_name": "unity/example", "name": "example", "scm": "git", "provider_id": "gh-1234" }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0 }, "gitlab": { "repository": { "owner": { "login": "unity", "name": "Unity", "avatar_url": "https://github.com/unity.png", "html_url": "https://github.com/unity" }, "clone_url": "https://github.com/unity/example.git", "archived_clone_url": "https://github.com/unity/example.git", "forks": 0, "watchers": 0, "full_name": "unity/example", "name": "example", "scm": "git", "provider_id": "gh-1234" }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0 }, "bitbucket": { "repository": { "owner": { "login": "unity", "name": "Unity", "avatar_url": "https://github.com/unity.png", "html_url": "https://github.com/unity" }, "clone_url": "https://github.com/unity/example.git", "archived_clone_url": "https://github.com/unity/example.git", "forks": 0, "watchers": 0, "full_name": "unity/example", "name": "example", "scm": "git", "provider_id": "gh-1234" }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0, "workspace": "my-workspace" }, "azure": { "repository": { "owner": { "login": "unity", "name": "Unity", "avatar_url": "https://github.com/unity.png", "html_url": "https://github.com/unity" }, "clone_url": "https://github.com/unity/example.git", "archived_clone_url": "https://github.com/unity/example.git", "forks": 0, "watchers": 0, "full_name": "unity/example", "name": "example", "scm": "git", "provider_id": "gh-1234" }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0, "azureOrg": "azureOrg", "azureProject": "azureProject" } }}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/scm/checkurl"

Response example

{ "isAccessible": true, "normalizedUrl": "https://github.com/unity/example-repo.git", "errorMessages": [ "Invalid URL format", "Repository not found" ], "capturedInfo": { "fingerprint": "a1b2c3d4e5f6g7h8i9j0" }}

Notify UCB that a commit has been made

Path parameters for "Notify UCB that a commit has been made"

orgid

string

required

No description

projectid

string

required

No description

Header parameters for "Notify UCB that a commit has been made"

x-hub-signature

string

No description

x-gitlab-token

string

No description

x-azure-token

string

No description

x-github-event

string

No description

x-gitlab-event

string

No description

x-event-key

string

No description

Query parameters for "Notify UCB that a commit has been made"

token

string

No description

Request body for "Notify UCB that a commit has been made"

Media Type:

application/json

HTTP response status codes for "Notify UCB that a commit has been made":

Accepted

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Notify UCB that a commit has been made":

Request example

curl -X POST \ -H "x-hub-signature: <x-hub-signature>" \ -H "x-gitlab-token: <x-gitlab-token>" \ -H "x-azure-token: <x-azure-token>" \ -H "x-github-event: <x-github-event>" \ -H "x-gitlab-event: <x-gitlab-event>" \ -H "x-event-key: <x-event-key>" \ -H "Content-Type: application/json" \ -d '{}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/hooks/scm/commit"

Response example

{ "sha": "abc123def456", "message": "feat: add new feature", "branch": "main", "timestamp": "2023-01-01T00:00:00Z", "author": { "email": "user@example.com", "name": "John Doe", "date": "2023-01-01T00:00:00Z" }}

List branches in the projects git repo

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "List branches in the projects git repo"

orgid

string

required

No description

projectid

string

required

No description

HTTP response status codes for "List branches in the projects git repo":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "List branches in the projects git repo":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/scm/git/branches"

Response example

[ "main", "develop"]

Get client workspace in the projects p4 repo

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get client workspace in the projects p4 repo"

orgid

string

required

No description

projectid

string

required

No description

client

string

required

No description

HTTP response status codes for "Get client workspace in the projects p4 repo":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get client workspace in the projects p4 repo":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/scm/p4/client/{client}"

Response example

"workspace-config"

List clients in the projects p4 repo

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "List clients in the projects p4 repo"

orgid

string

required

No description

projectid

string

required

No description

HTTP response status codes for "List clients in the projects p4 repo":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "List clients in the projects p4 repo":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/scm/p4/clients"

Response example

[ "client1", "client2"]

List branches in the selected repo for the project

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "List branches in the selected repo for the project"

orgid

string

required

No description

projectid

string

required

No description

repo

string

required

No description

HTTP response status codes for "List branches in the selected repo for the project":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "List branches in the selected repo for the project":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/scm/plastic/repos/{repo}/branches"

Response example

[ "main", "develop"]

List repos in the projects plastic server

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "List repos in the projects plastic server"

orgid

string

required

No description

projectid

string

required

No description

HTTP response status codes for "List repos in the projects plastic server":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "List repos in the projects plastic server":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/scm/plastic/repos"

Response example

[ { "name": "MyRepository", "description": "Repository description", "isPrivate": true, "defaultBranch": "main", "id": 12345, "created_at": "2023-01-01T00:00:00Z", "updated_at": "2023-01-01T00:00:00Z" }]

List folders in the projects svn repo

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "List folders in the projects svn repo"

orgid

string

required

No description

projectid

string

required

No description

Query parameters for "List folders in the projects svn repo"

subfolder

string

No description

HTTP response status codes for "List folders in the projects svn repo":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "List folders in the projects svn repo":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/scm/svn/folders"

Response example

[ "trunk/folder1", "trunk/folder2"]

List scene-preview build targets

Returns every scene-preview build target for the project, each with its latest build attempt (any status) and its latest successful build.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "List scene-preview build targets"

orgid

string

required

No description

projectid

string

required

No description

HTTP response status codes for "List scene-preview build targets":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "List scene-preview build targets":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/scenepreviews"

Response example

[ { "buildTargetId": "default-webgl", "name": "Default WebGL", "platform": "webgl", "enabled": true, "scenePreview": true, "targetType": "normal", "branch": "main", "buildProfilePath": "Assets/settings/build profiles/development", "latestBuild": { "buildNumber": 23, "buildStatus": "failure", "platform": "webgl", "branch": "main", "commitHash": "0C2E4F1D82D7E679403E32E323F798CC78348731", "unityVersion": "6000.3.2f1", "operatingSystem": "macos", "operatingSystemVersion": "sonoma", "xcodeVersion": "16.1.0", "architecture": "Apple-Silicon", "buildProfilePath": "Assets/settings/build profiles/development", "machineType": "STANDARD - 4 vCPU, 16GB memory, 512 GB disk", "startedAt": "2026-06-01T00:00:00Z", "completedAt": "2026-06-01T00:05:00Z" }, "latestSuccessfulBuild": { "buildNumber": 23, "buildStatus": "failure", "platform": "webgl", "branch": "main", "commitHash": "0C2E4F1D82D7E679403E32E323F798CC78348731", "unityVersion": "6000.3.2f1", "operatingSystem": "macos", "operatingSystemVersion": "sonoma", "xcodeVersion": "16.1.0", "architecture": "Apple-Silicon", "buildProfilePath": "Assets/settings/build profiles/development", "machineType": "STANDARD - 4 vCPU, 16GB memory, 512 GB disk", "startedAt": "2026-06-01T00:00:00Z", "completedAt": "2026-06-01T00:05:00Z" } }]

Get a single scene-preview build target

Returns one scene-preview build target with its latest build attempt (any status) and its latest successful build.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get a single scene-preview build target"

orgid

string

required

No description

projectid

string

required

No description

buildtargetid

string

required

No description

HTTP response status codes for "Get a single scene-preview build target":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get a single scene-preview build target":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/scenepreviews/{buildtargetid}"

Response example

{ "buildTargetId": "default-webgl", "name": "Default WebGL", "platform": "webgl", "enabled": true, "scenePreview": true, "targetType": "normal", "branch": "main", "buildProfilePath": "Assets/settings/build profiles/development", "latestBuild": { "buildNumber": 23, "buildStatus": "failure", "platform": "webgl", "branch": "main", "commitHash": "0C2E4F1D82D7E679403E32E323F798CC78348731", "unityVersion": "6000.3.2f1", "operatingSystem": "macos", "operatingSystemVersion": "sonoma", "xcodeVersion": "16.1.0", "architecture": "Apple-Silicon", "buildProfilePath": "Assets/settings/build profiles/development", "machineType": "STANDARD - 4 vCPU, 16GB memory, 512 GB disk", "startedAt": "2026-06-01T00:00:00Z", "completedAt": "2026-06-01T00:05:00Z" }, "latestSuccessfulBuild": { "buildNumber": 23, "buildStatus": "failure", "platform": "webgl", "branch": "main", "commitHash": "0C2E4F1D82D7E679403E32E323F798CC78348731", "unityVersion": "6000.3.2f1", "operatingSystem": "macos", "operatingSystemVersion": "sonoma", "xcodeVersion": "16.1.0", "architecture": "Apple-Silicon", "buildProfilePath": "Assets/settings/build profiles/development", "machineType": "STANDARD - 4 vCPU, 16GB memory, 512 GB disk", "startedAt": "2026-06-01T00:00:00Z", "completedAt": "2026-06-01T00:05:00Z" }}

Get retention policies for a project.

Returns a list of retention policies configured for the specified project.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get retention policies for a project."

orgid

string

required

No description

projectid

string

required

No description

HTTP response status codes for "Get retention policies for a project.":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get retention policies for a project.":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/retentionpolicies"

Response example

[ { "guid": "550e8400-e29b-41d4-a716-446655440000", "type": "timeLimitDays", "retentionValue": 30, "retainLogs": false, "enabled": true }]

Create a retention policy for a project.

Creates a new retention policy with the specified configuration.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Create a retention policy for a project."

orgid

string

required

No description

projectid

string

required

No description

Request body for "Create a retention policy for a project."

Media Type:

application/json

type

string

required

Retention policy type

retentionValue

integer

required

example: 30

The retention value: number of days to retain for

timeLimitDays

(1–365), or number of builds to retain for

buildCountLimit

(1–1000). The allowed range depends on

type

.

retainLogs

boolean

example: false

Whether logs should be retained when build attempts are deleted. When true, the build attempt is also kept visible (its

deleted

flag stays false); when false, the build attempt is marked deleted.

enabled

boolean

example: true

Whether this retention policy is active. When false, the retention worker skips the policy and no build attempts are deleted for it.

HTTP response status codes for "Create a retention policy for a project.":

Created

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Create a retention policy for a project.":

Request example

curl -X POST \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: application/json" \ -d '{ "type": "timeLimitDays", "retentionValue": 30, "retainLogs": false, "enabled": true}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/retentionpolicies"

Response example

{ "guid": "550e8400-e29b-41d4-a716-446655440000", "type": "timeLimitDays", "retentionValue": 30, "retainLogs": false, "enabled": true}

Get retention policy details.

Returns detailed information about a specific retention policy.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get retention policy details."

orgid

string

required

No description

projectid

string

required

No description

retentionpolicyguid

required

No description

HTTP response status codes for "Get retention policy details.":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get retention policy details.":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/retentionpolicies/{retentionpolicyguid}"

Response example

{ "guid": "550e8400-e29b-41d4-a716-446655440000", "type": "timeLimitDays", "retentionValue": 30, "retainLogs": false, "enabled": true}

Update a retention policy.

Updates an existing retention policy with new values.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Update a retention policy."

orgid

string

required

No description

projectid

string

required

No description

retentionpolicyguid

required

No description

Request body for "Update a retention policy."

Media Type:

application/json

retentionValue

integer

example: 30

The retention value: number of days to retain for a

timeLimitDays

policy (1–365), or number of builds to retain for a

buildCountLimit

policy (1–1000). The type-specific upper bound is enforced against the existing policy's type.

retainLogs

boolean

example: false

Whether logs should be retained when build attempts are deleted. When true, the build attempt is also kept visible (its

deleted

flag stays false); when false, the build attempt is marked deleted.

enabled

boolean

example: true

Whether this retention policy is active. When false, the retention worker skips the policy and no build attempts are deleted for it.

HTTP response status codes for "Update a retention policy.":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Update a retention policy.":

Request example

curl -X PUT \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: application/json" \ -d '{ "retentionValue": 30, "retainLogs": false, "enabled": true}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/retentionpolicies/{retentionpolicyguid}"

Response example

{ "guid": "550e8400-e29b-41d4-a716-446655440000", "type": "timeLimitDays", "retentionValue": 30, "retainLogs": false, "enabled": true}

Delete a retention policy.

Deletes a retention policy from a project.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Delete a retention policy."

orgid

string

required

No description

projectid

string

required

No description

retentionpolicyguid

required

No description

HTTP response status codes for "Delete a retention policy.":

No Content

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Delete a retention policy.":

Request example

curl -X DELETE \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/retentionpolicies/{retentionpolicyguid}"

Response example

{ "requestId": "string", "details": [ {} ], "detail": "string", "type": "string", "code": 0, "title": "string", "status": 0}

Get project details.

Returns detailed information about a specific project.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get project details."

orgid

string

required

No description

projectid

string

required

No description

Query parameters for "Get project details."

include

array

No description

HTTP response status codes for "Get project details.":

Ok

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get project details.":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}"

Response example

{ "settings": { "remoteCacheStrategy": "inherit", "cacheCompressionLevel": "1", "artifactCompressionLevel": "1", "scm": { "type": "git", "url": "git@github.com:UnityTechnologies/exampleProject.git", "url_buildjob": "https://git.internal.example.com/org/repo.git", "user": "build_automat_service_account", "pass": "********", "fingerprint": "string", "authType": "UPWorkingMode", "plasticAccessToken": "string", "shallowclone": false, "windowsGitBinary": "cygwin", "useEncryption": false, "encryptionKey": "string", "encryptionMethod": "AES128", "plasticEnvironment": "prd", "oauth": { "scm_provider": "scm_provider", "temp_state": "temp_state", "github": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0 }, "gitlab": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0 }, "bitbucket": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0, "workspace": "my-workspace" }, "azure": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0, "azureOrg": "azureOrg", "azureProject": "azureProject" } } } }, "created": "2025-01-01T18:45:00.000Z", "disabled": false, "disableNotifications": false, "generateShareLinks": false, "beautifulCornerSecondaryWorkspace": false, "projectid": "95a0de7c-8f1d-4d2d-8c03-9b711fac5ff8", "name": "Example Project", "orgName": "Example Organization", "serviceFlags": {}, "orgid": "e62c8c9f-8f1d-4d2d-8c03-9b711fac5ff8", "guid": "95a0de7c-8f1d-4d2d-8c03-9b711fac5ff8", "orgFk": "20066741877351", "buildTimeoutMinutes": 60, "cachedIcon": "https://storage.googleapis.com/some-random-bucket/.../icon.png", "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "list_buildtargets": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "latest_builds": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "revoke_all_shared": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false } }}

Update project details

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Update project details"

orgid

string

required

No description

projectid

string

required

No description

Request body for "Update project details"

Media Type:

application/json

name

string

example: My Project

No description

coppa

boolean

example: false

No description

disabled

boolean

example: false

No description

disableNotifications

boolean

example: false

No description

generateShareLinks

boolean

example: true

No description

beautifulCornerSecondaryWorkspace

boolean

example: false

No description

buildTimeoutMinutes

integer

example: 60

No description

settings

object

Project Settings object

autoBuildLatest

string

Auto-build latest option. - inherit: Inherit the auto-build latest setting from the organization

remoteCacheStrategy

string

Subset of cache strategies available for project settings. - none: Do not use caching - library: Cache the Library folder - workspace: Cache the entire workspace

cacheCompressionLevel

string

Compression level for cache or artifacts. Values: 'none' (no compression) or '1' through '9' (higher numbers = more compression)

artifactCompressionLevel

string

Compression level for cache or artifacts. Values: 'none' (no compression) or '1' through '9' (higher numbers = more compression)

scm

object

Scm object

type

string

Source control management (SCM) system type. Values: 'git', 'svn', 'p4' (Perforce), 'oauth', or 'plastic' (UVCS)

url

string

example: url

No description

url_buildjob

string

example: https://git.internal.example.com/org/repo.git

Overrides

url

for the build job only, leaving the URL the API reaches unchanged. Used when the builder must take a different route to the repository, such as over a VPN.

user

string

example: user

No description

pass

string

example: pass

No description

fingerprint

string

example: fingerprint

No description

p4authtype

string

example: p4authtype

Deprecated p4-specific auth type - please use authType instead

authType

string

Authentication type for Perforce or Plastic SCM. Perforce: 'ticket' or 'password' Plastic: 'UPWorkingMode', 'LDAPWorkingMode', or 'SSOWorkingMode'

plasticAccessToken

string

example: plasticAccessToken

No description

shallowclone

boolean

example: true

No description

windowsGitBinary

string

Windows Git binary type. - cygwin: Use Cygwin version of git - native: Use native Windows version of git

useEncryption

boolean

example: true

No description

encryptionKey

string

example: a1b2c3d4e5f6g7h8i9j0

No description

encryptionMethod

string

Plastic SCM encryption method. Values: 'AES128', 'AES192', or 'AES256' (Advanced Encryption Standard with key size)

plasticEnvironment

string

Plastic SCM environment. Values: 'prd' (production) or 'stg' (staging)

oauth

object

OAuth configuration for SCM providers

scm_provider

string

example: scm_provider

No description

temp_state

string

example: temp_state

No description

github

object

Base OAuth provider settings (shared by GitHub, GitLab, Bitbucket, and extended by Azure OAuth)

gitlab

object

Base OAuth provider settings (shared by GitHub, GitLab, Bitbucket, and extended by Azure OAuth)

bitbucket

object

Bitbucket OAuth configuration (extends base OAuth provider settings)

azure

object

Azure OAuth configuration (extends base OAuth provider settings)

isUnityCloudDrive

boolean

example: true

If true, the build will use the Unity Cloud Drive for the source code (only applies to UVCS projects).

repo

string

example: repo

Which repo to use. Only applies to Plastic SCM, other SCM types configure repo on the project level.

branch

string

example: branch

No description

subdirectory

string

example: subdirectory

subdirectory to build from

client

string

example: client

perforce only client workspace to build from

HTTP response status codes for "Update project details":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Update project details":

Request example

curl -X PUT \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: application/json" \ -d '{ "name": "My Project", "coppa": false, "disabled": false, "disableNotifications": false, "generateShareLinks": true, "beautifulCornerSecondaryWorkspace": false, "buildTimeoutMinutes": 60, "settings": { "autoBuildLatest": "inherit", "remoteCacheStrategy": "library", "cacheCompressionLevel": "1", "artifactCompressionLevel": "1", "scm": { "type": "git", "url": "url", "url_buildjob": "https://git.internal.example.com/org/repo.git", "user": "user", "pass": "pass", "fingerprint": "fingerprint", "p4authtype": "p4authtype", "authType": "UPWorkingMode", "plasticAccessToken": "plasticAccessToken", "shallowclone": true, "windowsGitBinary": "cygwin", "useEncryption": true, "encryptionKey": "a1b2c3d4e5f6g7h8i9j0", "encryptionMethod": "AES128", "plasticEnvironment": "prd", "oauth": { "scm_provider": "scm_provider", "temp_state": "temp_state", "github": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0 }, "gitlab": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0 }, "bitbucket": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0, "workspace": "my-workspace" }, "azure": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0, "azureOrg": "azureOrg", "azureProject": "azureProject" } }, "isUnityCloudDrive": true, "repo": "repo", "branch": "branch", "subdirectory": "subdirectory", "client": "client" } }}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}"

Response example

{ "name": "John Doe", "projectid": "1234567890", "orgName": "orgName", "orgid": "1234567890", "orgFk": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "guid": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "created": "2023-01-01T00:00:00Z", "cachedIcon": "https://example.com/icon.png", "serviceFlags": {}, "links": {}, "disabled": true, "disableNotifications": true, "generateShareLinks": true, "buildTimeoutMinutes": 60, "beautifulCornerSecondaryWorkspace": false, "settings": { "autoBuildLatest": "inherit", "remoteCacheStrategy": "library", "cacheCompressionLevel": "1", "artifactCompressionLevel": "1", "scm": { "type": "git", "url": "url", "url_buildjob": "https://git.internal.example.com/org/repo.git", "user": "user", "pass": "pass", "fingerprint": "fingerprint", "p4authtype": "p4authtype", "authType": "UPWorkingMode", "plasticAccessToken": "plasticAccessToken", "shallowclone": true, "windowsGitBinary": "cygwin", "useEncryption": true, "encryptionKey": "a1b2c3d4e5f6g7h8i9j0", "encryptionMethod": "AES128", "plasticEnvironment": "prd", "oauth": { "scm_provider": "scm_provider", "temp_state": "temp_state", "github": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0 }, "gitlab": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0 }, "bitbucket": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0, "workspace": "my-workspace" }, "azure": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0, "azureOrg": "azureOrg", "azureProject": "azureProject" } }, "isUnityCloudDrive": true, "repo": "repo", "branch": "branch", "subdirectory": "subdirectory", "client": "client" } }}

Archive project

This will archive the project in Build Automation ONLY. Use with caution - this process is not reversible. The projects UPID will be removed from Build Automation allowing the project to be reconfigured.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Archive project"

orgid

string

required

No description

projectid

string

required

No description

HTTP response status codes for "Archive project":

No Content

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Archive project":

Request example

curl -X DELETE \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}"

Response example

{ "requestId": "string", "details": [ {} ], "detail": "string", "type": "string", "code": 0, "title": "string", "status": 0}

List projects for an organization.

Returns the projects that belong to the specified organization.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "List projects for an organization."

orgid

string

required

No description

Query parameters for "List projects for an organization."

include

array

No description

HTTP response status codes for "List projects for an organization.":

Ok

4XX

Client Side Error

5XX

Server Side Error

Code samples for "List projects for an organization.":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects"

Response example

[ { "settings": { "remoteCacheStrategy": "inherit", "cacheCompressionLevel": "1", "artifactCompressionLevel": "1", "scm": { "type": "git", "url": "git@github.com:UnityTechnologies/exampleProject.git", "url_buildjob": "https://git.internal.example.com/org/repo.git", "user": "build_automat_service_account", "pass": "********", "fingerprint": "string", "authType": "UPWorkingMode", "plasticAccessToken": "string", "shallowclone": false, "windowsGitBinary": "cygwin", "useEncryption": false, "encryptionKey": "string", "encryptionMethod": "AES128", "plasticEnvironment": "prd", "oauth": { "scm_provider": "scm_provider", "temp_state": "temp_state", "github": { "repository": null, "token": null, "refreshToken": null, "expiration": null, "expirationInterval": null }, "gitlab": { "repository": null, "token": null, "refreshToken": null, "expiration": null, "expirationInterval": null }, "bitbucket": { "repository": null, "token": null, "refreshToken": null, "expiration": null, "expirationInterval": null, "workspace": null }, "azure": { "repository": null, "token": null, "refreshToken": null, "expiration": null, "expirationInterval": null, "azureOrg": null, "azureProject": null } } } }, "created": "2025-01-01T18:45:00.000Z", "disabled": false, "disableNotifications": false, "generateShareLinks": false, "beautifulCornerSecondaryWorkspace": false, "projectid": "95a0de7c-8f1d-4d2d-8c03-9b711fac5ff8", "name": "Example Project", "orgName": "Example Organization", "serviceFlags": {}, "orgid": "e62c8c9f-8f1d-4d2d-8c03-9b711fac5ff8", "guid": "95a0de7c-8f1d-4d2d-8c03-9b711fac5ff8", "orgFk": "20066741877351", "buildTimeoutMinutes": 60, "cachedIcon": "https://storage.googleapis.com/some-random-bucket/.../icon.png", "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "list_buildtargets": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "latest_builds": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "revoke_all_shared": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false } } }]

Get project details by project ID

Get project by project ID

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get project details by project ID"

projectid

string

required

No description

Query parameters for "Get project details by project ID"

include

array

No description

HTTP response status codes for "Get project details by project ID":

Detailed information about a specific project, identified by its project ID only (no org scope required).

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get project details by project ID":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/projects/{projectid}"

Response example

{ "settings": { "remoteCacheStrategy": "inherit", "cacheCompressionLevel": "1", "artifactCompressionLevel": "1", "scm": { "type": "git", "url": "git@github.com:UnityTechnologies/exampleProject.git", "url_buildjob": "https://git.internal.example.com/org/repo.git", "user": "build_automat_service_account", "pass": "********", "fingerprint": "string", "authType": "UPWorkingMode", "plasticAccessToken": "string", "shallowclone": false, "windowsGitBinary": "cygwin", "useEncryption": false, "encryptionKey": "string", "encryptionMethod": "AES128", "plasticEnvironment": "prd", "oauth": { "scm_provider": "scm_provider", "temp_state": "temp_state", "github": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0 }, "gitlab": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0 }, "bitbucket": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0, "workspace": "my-workspace" }, "azure": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0, "azureOrg": "azureOrg", "azureProject": "azureProject" } } } }, "created": "2025-01-01T18:45:00.000Z", "disabled": false, "disableNotifications": false, "generateShareLinks": false, "beautifulCornerSecondaryWorkspace": false, "projectid": "95a0de7c-8f1d-4d2d-8c03-9b711fac5ff8", "name": "Example Project", "orgName": "Example Organization", "serviceFlags": {}, "orgid": "e62c8c9f-8f1d-4d2d-8c03-9b711fac5ff8", "guid": "95a0de7c-8f1d-4d2d-8c03-9b711fac5ff8", "orgFk": "20066741877351", "buildTimeoutMinutes": 60, "cachedIcon": "https://storage.googleapis.com/some-random-bucket/.../icon.png", "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "list_buildtargets": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "latest_builds": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "revoke_all_shared": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false } }}

Get audit log

Retrieve a list of historical settings changes for this project

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get audit log"

orgid

string

required

No description

projectid

string

required

No description

Query parameters for "Get audit log"

per_page

integer

default: 25

example: 25

The maximum number of items to return in a single request

page

integer

default: 1

example: 1

The page number to return

HTTP response status codes for "Get audit log":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get audit log":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/auditlog"

Response example

[ { "action": "created", "timestamp": "2023-01-01T00:00:00Z", "user": "user@example.com" }]

Get billing plan

Get the billing plan for the specified project

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get billing plan"

orgid

string

required

No description

projectid

string

required

No description

Query parameters for "Get billing plan"

refresh

boolean

No description

HTTP response status codes for "Get billing plan":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get billing plan":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/billingplan"

Response example

{ "billing": { "label": "Production Build", "numProjects": 3, "concurrentBuilds": 4, "cooldownMinutes": 5, "cooldownGracePeriodMinutes": 10, "collaborators": 8, "repoSizeLimitMB": 10240, "repoSizeLimitThresholdMB": 9216, "downloadLimitMB": 5120, "buildManifest": true, "libraryCaching": true, "pushExternalServices": true, "supportTickets": true, "apiAccess": true, "scheduledBuilds": true, "workspaceCaching": true, "buildingDisabled": true, "advancedFeatures": [ "cloudBuild", "collaborate" ], "scmTypes": [ "git", "p4" ] }, "effective": { "date": "2024-01-01T00:00:00.000Z", "type": "immediate" }}

Get project raw details

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get project raw details"

orgid

string

required

No description

projectid

string

required

No description

Query parameters for "Get project raw details"

include

array

No description

HTTP response status codes for "Get project raw details":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get project raw details":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/raw"

Response example

{ "name": "John Doe", "projectid": "1234567890", "orgName": "orgName", "orgid": "1234567890", "orgFk": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "guid": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "created": "2023-01-01T00:00:00Z", "cachedIcon": "https://example.com/icon.png", "serviceFlags": {}, "links": {}, "disabled": true, "disableNotifications": true, "generateShareLinks": true, "buildTimeoutMinutes": 60, "beautifulCornerSecondaryWorkspace": false, "settings": { "autoBuildLatest": "inherit", "remoteCacheStrategy": "library", "cacheCompressionLevel": "1", "artifactCompressionLevel": "1", "scm": { "type": "git", "url": "url", "url_buildjob": "https://git.internal.example.com/org/repo.git", "user": "user", "pass": "pass", "fingerprint": "fingerprint", "p4authtype": "p4authtype", "authType": "UPWorkingMode", "plasticAccessToken": "plasticAccessToken", "shallowclone": true, "windowsGitBinary": "cygwin", "useEncryption": true, "encryptionKey": "a1b2c3d4e5f6g7h8i9j0", "encryptionMethod": "AES128", "plasticEnvironment": "prd", "oauth": { "scm_provider": "scm_provider", "temp_state": "temp_state", "github": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0 }, "gitlab": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0 }, "bitbucket": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0, "workspace": "my-workspace" }, "azure": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0, "azureOrg": "azureOrg", "azureProject": "azureProject" } }, "isUnityCloudDrive": true, "repo": "repo", "branch": "branch", "subdirectory": "subdirectory", "client": "client" } }}

Get SSH Key

Get the ssh public key for the specified project

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get SSH Key"

orgid

string

required

No description

projectid

string

required

No description

HTTP response status codes for "Get SSH Key":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get SSH Key":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/sshkey"

Response example

{ "publickey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC...", "type": "type"}

Get Raw SSH Key

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get Raw SSH Key"

orgid

string

required

No description

projectid

string

required

No description

Query parameters for "Get Raw SSH Key"

type

string

No description

HTTP response status codes for "Get Raw SSH Key":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get Raw SSH Key":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/sshkey/raw"

Response example

{ "publickey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC...", "privatekey": "privatekey", "type": "type"}

Get project statistics

Get statistics for the specified project

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get project statistics"

orgid

string

required

No description

projectid

string

required

No description

Query parameters for "Get project statistics"

includeDeleted

boolean

No description

HTTP response status codes for "Get project statistics":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get project statistics":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/stats"

Response example

{ "jobCount": 42, "buildSuccessHealth": 6.027456183070403, "buildPoorHealth": 1.4658129805029452, "buildCancelHealth": 5.962133916683182, "buildPendingHealth": 5.637376656633329, "successfulBuilds": 12, "canceledBuilds": 1, "failedBuilds": 3, "averageTime": 3.616076749251911, "averageWorkspaceSize": 2.027123023002322, "averageWaitTime": 4.145608029883936, "averageBillableTime": 7.386281948385884, "averageBuildTime": 1.2315135367772556, "maxConcurrentBuilds": 4, "availableConcurrentBuilds": 2}

Query Project Preview build state

Returns Project Preview build targets for the project, plus the most recent build for each. Optional query parameters filter the result set by branch, repo, and platform.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Query Project Preview build state"

orgid

string

required

No description

projectid

string

required

No description

Query parameters for "Query Project Preview build state"

branch

string

example: main

No description

repo

string

example: my-repo

No description

platform

No description

HTTP response status codes for "Query Project Preview build state":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Query Project Preview build state":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/projectpreview"

Response example

[ { "buildTargetId": "asset-preview-standaloneosx-master", "platform": "standaloneosx", "branch": "master", "repo": "my-repo", "subdirectory": "subdir", "buildProfilePath": "Assets/Settings/MyBuildProfile.asset", "cacheRepo": "myorg/myproject_cache", "cacheBranch": "asset-preview-cache/abc123", "isCachePopulated": false, "generateProjectPreview3D": false, "latestBuild": { "buildStatus": "success", "buildNumber": 42, "branch": "main", "repo": "my-repo", "startedAt": "2026-06-01T00:00:00Z", "completedAt": "2026-06-01T00:05:00Z", "commitHash": "abc123def456" }, "runningBuilds": [ { "buildStatus": "started", "buildNumber": 43, "branch": "main", "repo": "my-repo", "startedAt": "2026-06-01T00:00:00Z", "completedAt": "2026-06-01T00:05:00Z", "commitHash": "abc123def456" } ] }]

List supported platforms

Queries the database for the supported platforms and returns the list of supported platforms.

Query parameters for "List supported platforms"

unityVersion

string

No description

platform

string

No description

HTTP response status codes for "List supported platforms":

Ok

4XX

Client Side Error

5XX

Server Side Error

Code samples for "List supported platforms":

Request example

curl -X GET \ "https://build-automation.services.api.unity.com/v2/platforms/supported"

Response example

[ { "platform": "standalonewindows", "name": "Windows x86", "editorIcon": "editorIcon", "operatingSystems": [ { "family": "mac", "versions": [ { "name": null, "value": null, "default": null, "deprecated": null, "architectures": null, "min_unity_version": null, "hidden": null, "default_xcode_version": null, "created": null, "unity_versions": null, "max_unity_version": null, "family": null, "xcode_versions": null, "finishTime": null } ], "defaultVersion": "sonomaSilicon" } ], "credentials": "none" }]

Get the Platform SDK requirements for the given Unity Version

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get the Platform SDK requirements for the given Unity Version"

orgid

string

required

No description

unityVersionValue

string

required

No description

Query parameters for "Get the Platform SDK requirements for the given Unity Version"

platform

string

No description

HTTP response status codes for "Get the Platform SDK requirements for the given Unity Version":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get the Platform SDK requirements for the given Unity Version":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/versions/sdk_config/{unityVersionValue}"

Response example

[ "5.0", "6.0"]

Exchanges for a Plastic token.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Header parameters for "Exchanges for a Plastic token."

x-plastic

string

No description

x-plastic-staging

string

No description

HTTP response status codes for "Exchanges for a Plastic token.":

Ok

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Exchanges for a Plastic token.":

Request example

curl -X POST \ -H "x-plastic: <x-plastic>" \ -H "x-plastic-staging: <x-plastic-staging>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/plastic/exchange"

Response example

{ "user": "user@email.com", "accessToken": "TOKENabc123", "refreshToken": "abc7ac09-3f70-428b-ade2-971812051a9b", "authAccessToken": "dGVzdFRva2VuCg==", "stagingUser": "user@email.com", "stagingAccessToken": "TOKENabc123", "stagingRefreshToken": "abc7ac09-3f70-428b-ade2-971812051a9b", "stagingAuthAccessToken": "dGVzdFRva2VuCg=="}

Get organization details.

Returns detailed information about a specific organization.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get organization details."

orgid

string

required

No description

HTTP response status codes for "Get organization details.":

Ok

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get organization details.":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}"

Response example

{ "orgName": "Unity Technologies", "orgid": "unity-technologies", "orgFk": "123456", "autoBuildLatest": true, "location": { "geographicRegion": "amer" }}

Update organization data

Update specific data for the specified organization in UBA's cache

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Update organization data"

orgid

string

required

No description

Request body for "Update organization data"

Media Type:

application/json

autoBuildLatest

boolean

example: true

No description

location

object

Location object

geographicRegion

string

example: us-east-1

No description

HTTP response status codes for "Update organization data":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Update organization data":

Request example

curl -X PATCH \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: application/json" \ -d '{ "autoBuildLatest": true, "location": { "geographicRegion": "us-east-1" }}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}"

Response example

{ "autoBuildLatest": true, "location": { "geographicRegion": "us-east-1" }}

Get billing plan

Get the billing plan for the specified organization

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get billing plan"

orgid

string

required

No description

Query parameters for "Get billing plan"

refresh

boolean

No description

HTTP response status codes for "Get billing plan":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get billing plan":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/billingplan"

Response example

{ "billing": { "label": "Production Build", "numProjects": 3, "concurrentBuilds": 4, "cooldownMinutes": 5, "cooldownGracePeriodMinutes": 10, "collaborators": 8, "repoSizeLimitMB": 10240, "repoSizeLimitThresholdMB": 9216, "downloadLimitMB": 5120, "buildManifest": true, "libraryCaching": true, "pushExternalServices": true, "supportTickets": true, "apiAccess": true, "scheduledBuilds": true, "workspaceCaching": true, "buildingDisabled": true, "advancedFeatures": [ "cloudBuild", "collaborate" ], "scmTypes": [ "git", "p4" ] }, "effective": { "date": "2024-01-01T00:00:00.000Z", "type": "immediate" }}

Get SSH Key

Get the ssh public key for the specified org

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get SSH Key"

orgid

string

required

No description

HTTP response status codes for "Get SSH Key":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get SSH Key":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/sshkey"

Response example

{ "publickey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC..."}

Regenerate SSH Key

Regenerate the ssh key for the specified org WARNING this is a destructive operation that will permanently remove your current SSH key.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Regenerate SSH Key"

orgid

string

required

No description

Query parameters for "Regenerate SSH Key"

type

string

No description

HTTP response status codes for "Regenerate SSH Key":

Created

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Regenerate SSH Key":

Request example

curl -X POST \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/sshkey"

Response example

{ "publickey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC..."}

Get concurrency limit

Get how many builds the organization can run at the same time.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get concurrency limit"

orgid

string

required

No description

HTTP response status codes for "Get concurrency limit":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get concurrency limit":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/concurrency-limit"

Response example

{ "limit": 5, "maxAllowable": 20}

Set concurrency limit

Set how many builds the organization can run at the same time. Builds beyond the limit stay queued.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Set concurrency limit"

orgid

string

required

No description

Request body for "Set concurrency limit"

Media Type:

application/json

limit

integer

required

example: 5

Builds the organization can run at the same time.

HTTP response status codes for "Set concurrency limit":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Set concurrency limit":

Request example

curl -X PUT \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: application/json" \ -d '{ "limit": 5}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/concurrency-limit"

Response example

{ "limit": 5, "maxAllowable": 20}

Check free tier status

Reports whether the organization has reached its free tier build limit.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Check free tier status"

orgid

string

required

No description

HTTP response status codes for "Check free tier status":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Check free tier status":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/free-tier-status"

Response example

{ "freeTierLimitReached": false}

Get Unity Pipeline enrollment status

Returns the Unity Pipeline enrollment status for the specified organization.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get Unity Pipeline enrollment status"

orgid

string

required

No description

HTTP response status codes for "Get Unity Pipeline enrollment status":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get Unity Pipeline enrollment status":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/unity-pipeline"

Response example

{ "enrolled": true}

Get an operating system version by key

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get an operating system version by key"

orgid

string

required

No description

projectid

string

required

No description

value

string

required

No description

HTTP response status codes for "Get an operating system version by key":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get an operating system version by key":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/versions/operatingsystem/{value}"

Response example

{ "name": "macOS Sonoma - Silicon", "value": "sonomaSilicon", "default": false, "deprecated": false, "architectures": [ "x64", "arm64" ], "min_unity_version": "2022.3.0f1", "hidden": true, "default_xcode_version": "xcode14_0", "created": "2023-01-01T00:00:00Z", "unity_versions": [ "2022.3.0f1", "2023.1.0f1" ], "max_unity_version": "2023.2.0f1", "family": "mac", "xcode_versions": [ "xcode13_2_1", "xcode14_0" ], "finishTime": "2023-12-31T23:59:59Z"}

List all operating system versions

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "List all operating system versions"

orgid

string

required

No description

projectid

string

required

No description

Query parameters for "List all operating system versions"

family

No description

version

string

No description

unity_version

string

No description

xcode_version

string

No description

HTTP response status codes for "List all operating system versions":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "List all operating system versions":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/versions/operatingsystem"

Response example

[ { "name": "macOS Sonoma - Silicon", "value": "sonomaSilicon", "default": false, "deprecated": false, "architectures": [ "x64", "arm64" ], "min_unity_version": "2022.3.0f1", "hidden": true, "default_xcode_version": "xcode14_0", "created": "2023-01-01T00:00:00Z", "unity_versions": [ "2022.3.0f1", "2023.1.0f1" ], "max_unity_version": "2023.2.0f1", "family": "mac", "xcode_versions": [ "xcode13_2_1", "xcode14_0" ], "finishTime": "2023-12-31T23:59:59Z" }]

Create a commit webhook for the configured repo

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Create a commit webhook for the configured repo"

orgid

string

required

No description

projectid

string

required

No description

key

string

required

No description

HTTP response status codes for "Create a commit webhook for the configured repo":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Create a commit webhook for the configured repo":

Request example

curl -X POST \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/oauth/{key}/createwebhook"

Response example

{ "id": "webhook_123", "url": "https://api.github.com/hooks", "name": "web", "active": true, "events": "push", "created_at": "2023-01-01T00:00:00Z", "updated_at": "2023-01-01T00:00:00Z"}

List branches in the project's repository

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "List branches in the project's repository"

orgid

string

required

No description

projectid

string

required

No description

key

string

required

No description

HTTP response status codes for "List branches in the project's repository":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "List branches in the project's repository":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/oauth/{key}/branches"

Response example

[ { "name": "main" }]

List available repositories

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "List available repositories"

orgid

string

required

No description

projectid

string

required

No description

key

string

required

No description

HTTP response status codes for "List available repositories":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "List available repositories":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/oauth/{key}/repos"

Response example

[ { "name": "Hello-World", "full_name": "octocat/Hello-World", "scm": "git", "provider_id": "12345", "watchers": 80, "forks": 9, "clone_url": "https://github.com/octocat/Hello-World.git", "owner": { "login": "octocat", "avatar_url": "https://github.com/images/error/octocat_happy.gif" } }]

List all enabled machine types

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "List all enabled machine types"

orgid

string

required

No description

projectid

string

required

No description

Query parameters for "List all enabled machine types"

operatingSystem

No description

operatingSystemVersion

string

No description

HTTP response status codes for "List all enabled machine types":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "List all enabled machine types":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/machinetypes"

Response example

[ { "name": "Standard_v1", "shortName": "win_standard_v1", "label": "win_standard_v1", "operatingSystem": "mac", "operatingSystemVersions": [ "sonomaSilicon", "venturaIntel" ], "enabled": true, "default": false, "isBestValue": true, "freeTierEligible": true, "sku": "Standard_D2s_v3", "cpuCores": 2, "memoryGB": 8, "videoMemoryGB": 1, "diskSizeGB": 100, "osDiskSizeGB": 30, "dataDriveType": "pooled" }]

Get categorized failures for a specific build.

Returns active failure indicators for the given build attempt.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get categorized failures for a specific build."

orgid

string

required

No description

projectid

string

required

No description

buildtargetid

string

required

No description

number

required

No description

HTTP response status codes for "Get categorized failures for a specific build.":

Ok

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get categorized failures for a specific build.":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}/failures"

Response example

{ "failures": [ { "displayName": "Git Checkout Error", "stage": "checkout", "step": "git-clone", "publicMessage": "Git authentication failed", "link": "https://docs.unity.com/git-setup", "logline": 123, "failureIndicatorLabel": "git_auth_failed" } ]}

Submit feedback for a specific failure indicator.

Allows users to mark a failure indicator as helpful or not helpful.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Submit feedback for a specific failure indicator."

orgid

string

required

No description

projectid

string

required

No description

buildtargetid

string

required

No description

number

required

No description

Request body for "Submit feedback for a specific failure indicator."

Media Type:

application/json

failureIndicatorLabel

string

required

example: build_failed

No description

feedback

string

required

User feedback type for build failures.

HTTP response status codes for "Submit feedback for a specific failure indicator.":

Ok

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Submit feedback for a specific failure indicator.":

Request example

curl -X POST \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: application/json" \ -d '{ "failureIndicatorLabel": "build_failed", "feedback": "helpful"}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}/failures/feedback"

Response example

{ "success": true}

Get failure indicator labels for a project.

Returns all unique failure indicator labels that have been detected for failures within the project.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get failure indicator labels for a project."

orgid

string

required

No description

projectid

string

required

No description

HTTP response status codes for "Get failure indicator labels for a project.":

Ok

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get failure indicator labels for a project.":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/failure-indicator-labels"

Response example

{ "labels": [ { "label": "git_auth_failed", "displayName": "Git Authentication Failed" } ]}

Get failure indicator labels for a build target.

Returns unique failure indicator labels detected for failures within the build target.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get failure indicator labels for a build target."

orgid

string

required

No description

projectid

string

required

No description

buildtargetid

string

required

No description

HTTP response status codes for "Get failure indicator labels for a build target.":

Ok

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get failure indicator labels for a build target.":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/failure-indicator-labels"

Response example

{ "labels": [ { "label": "git_auth_failed", "displayName": "Git Authentication Failed" } ]}

Get environment variables

Get all configured environment variables for a given build target

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get environment variables"

orgid

string

required

No description

projectid

string

required

No description

buildtargetid

string

required

No description

HTTP response status codes for "Get environment variables":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get environment variables":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/envvars"

Response example

{ "API_URL": "https://build-api.cloud.unity3d.com/", "FEATURE_FLAG": "true"}

Set environment variables

Set all configured environment variables for a given build target

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Set environment variables"

orgid

string

required

No description

projectid

string

required

No description

buildtargetid

string

required

No description

Request body for "Set environment variables"

Media Type:

application/json

HTTP response status codes for "Set environment variables":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Set environment variables":

Request example

curl -X PUT \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: application/json" \ -d '{}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/envvars"

Response example

{ "API_URL": "https://build-api.cloud.unity3d.com/", "FEATURE_FLAG": "true"}

Get environment variables

Get all configured environment variables for a given project

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get environment variables"

orgid

string

required

No description

projectid

string

required

No description

HTTP response status codes for "Get environment variables":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get environment variables":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/envvars"

Response example

{ "API_URL": "https://build-api.cloud.unity3d.com/", "FEATURE_FLAG": "true"}

Set environment variables

Set all configured environment variables for a given project

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Set environment variables"

orgid

string

required

No description

projectid

string

required

No description

Request body for "Set environment variables"

Media Type:

application/json

HTTP response status codes for "Set environment variables":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Set environment variables":

Request example

curl -X PUT \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: application/json" \ -d '{}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/envvars"

Response example

{ "API_URL": "https://build-api.cloud.unity3d.com/", "FEATURE_FLAG": "true"}

Get machine types, xcode versions, and operating system versions

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get machine types, xcode versions, and operating system versions"

orgid

string

required

No description

projectid

string

required

No description

Query parameters for "Get machine types, xcode versions, and operating system versions"

family

No description

version

string

No description

unity_version

string

No description

xcode_version

string

No description

operatingSystem

string

No description

operatingSystemVersion

string

No description

HTTP response status codes for "Get machine types, xcode versions, and operating system versions":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get machine types, xcode versions, and operating system versions":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/editor/config"

Response example

{ "machineTypes": [ { "name": "Standard_v1", "shortName": "win_standard_v1", "label": "win_standard_v1", "operatingSystem": "mac", "operatingSystemVersions": [ "sonomaSilicon", "venturaIntel" ], "enabled": true, "default": false, "isBestValue": true, "freeTierEligible": true, "sku": "Standard_D2s_v3", "cpuCores": 2, "memoryGB": 8, "videoMemoryGB": 1, "diskSizeGB": 100, "osDiskSizeGB": 30, "dataDriveType": "pooled" } ], "xcodeVersions": [ { "hidden": true, "deprecated": true, "name": "John Doe", "value": "example-value" } ], "operatingSystemVersions": [ { "name": "macOS Sonoma - Silicon", "value": "sonomaSilicon", "default": false, "deprecated": false, "architectures": [ "x64", "arm64" ], "min_unity_version": "2022.3.0f1", "hidden": true, "default_xcode_version": "xcode14_0", "created": "2023-01-01T00:00:00Z", "unity_versions": [ "2022.3.0f1", "2023.1.0f1" ], "max_unity_version": "2023.2.0f1", "family": "mac", "xcode_versions": [ "xcode13_2_1", "xcode14_0" ], "finishTime": "2023-12-31T23:59:59Z" } ], "androidSdkConfig": [ { "name": "John Doe", "value": "example-value" } ]}

Generate a plist file for device distribution

Renders the iOS

itms-services

manifest plist that wraps a signed IPA URL so iOS can install it directly. Public, unauthenticated by design — org context is implicit in the pre-signed

bundle

/

icon

URLs supplied by the caller (typically the dashboard via

getShareMetadata

).

Query parameters for "Generate a plist file for device distribution"

bundle

string

required

example: https://storage.googleapis.com/bucket/example-org/new-project/ios-builder-1.ipa?sig=abc

Pre-signed download URL for the IPA (

software-package

asset).

bundleid

string

required

example: com.example.MyGame

iOS bundle identifier embedded in the IPA (e.g.

com.example.MyGame

).

Older iOS user agents (8.x) get

.ios8

appended server-side.

icon

string

required

example: https://storage.googleapis.com/bucket/example-org/new-project/ios-builder-1-icon.png?sig=abc

Pre-signed URL for the 57x57 PNG icon shown by iOS during install.

projectName

string

required

example: My Game

Display title shown by iOS during install (the project name).

HTTP response status codes for "Generate a plist file for device distribution":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Generate a plist file for device distribution":

Request example

curl -X GET \ "https://build-automation.services.api.unity.com/v2/device/distribution/plist"

Response example

"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<plist version=\"1.0\">\n<dict>\n\t<key>Items</key>\n\t<array/>\n</dict>\n</plist>"

Get device configuration plist for a specific device ID

Streams the global signed Apple Configuration Profile that prompts the device for its UDID/IMEI/etc. and posts them to the

/device/profile_installation/callback

endpoint. Public, unauthenticated by design — there is no per-device or per-org branching; the dashboard binds the returned attributes to a user when the callback redirects there.

HTTP response status codes for "Get device configuration plist for a specific device ID":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get device configuration plist for a specific device ID":

Request example

curl -X GET \ "https://build-automation.services.api.unity.com/v2/device/deviceid.mobileconfig"

Response example

"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n<plist version=\"1.0\">\n<dict/>\n</plist>"

Handle iOS profile installation callback

Receives the PKCS7-signed plist that iOS posts back after the device downloads

deviceid.mobileconfig

. Extracts UDID, VERSION, DEVICE_NAME, and PRODUCT from the embedded XML, then 301-redirects to the dashboard's device-registration URL with those values as query parameters. Public, unauthenticated by design — iOS posts to this URL directly with no user session context; the dashboard binds the device attributes to a user after the redirect lands.

HTTP response status codes for "Handle iOS profile installation callback":

Redirect to dashboard registration URL

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Handle iOS profile installation callback":

Request example

curl -X POST \ "https://build-automation.services.api.unity.com/v2/device/profile_installation/callback"

Response example

{ "requestId": "string", "details": [ {} ], "detail": "string", "type": "string", "code": 0, "title": "string", "status": 0}

Get All Android Credentials

Get all credentials available for the project. A user in the projects org will see all credentials uploaded for any project within the org, whereas a user with project-level permissions will only see credentials assigned to the specific project.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get All Android Credentials"

orgid

string

required

No description

projectid

string

required

No description

HTTP response status codes for "Get All Android Credentials":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get All Android Credentials":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/credentials/signing/android"

Response example

[ { "platform": "webgl", "label": "Auto Generated Debug Keystore", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2015-08-27T22:29:00.023Z", "lastMod": "2015-08-27T22:29:00.023Z", "keystore": { "alias": "my-keystore-alias", "debug": true, "expiration": "2025-12-31T23:59:59.000Z" }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] } }]

Upload Android Credentials

Upload a new android keystore for the project. NOTE: you must be a manager in the project's organization to add new credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Upload Android Credentials"

orgid

string

required

No description

projectid

string

required

No description

Request body for "Upload Android Credentials"

Media Type:

multipart/form-data

label

string

required

Label for the uploaded credentials

alias

string

required

Keystore alias

keypass

string

required

Keystore keypass

storepass

string

required

Keystore storepass

file

string

required

Keystore file

HTTP response status codes for "Upload Android Credentials":

Created

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Upload Android Credentials":

Request example

curl -X POST \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: multipart/form-data" \ -d '{"label":"string","alias":"string","keypass":"string","storepass":"string","file":"string"}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/credentials/signing/android"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "keystore": { "alias": "my-keystore-alias", "debug": true, "expiration": "2025-12-31T23:59:59.000Z" }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Get All Android Credentials for an organization

Get all credentials available for the organization. A list of projects using a credential is included in the links element.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get All Android Credentials for an organization"

orgid

string

required

No description

HTTP response status codes for "Get All Android Credentials for an organization":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get All Android Credentials for an organization":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/credentials/signing/android"

Response example

[ { "platform": "webgl", "label": "Auto Generated Debug Keystore", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2015-08-27T22:29:00.023Z", "lastMod": "2015-08-27T22:29:00.023Z", "keystore": { "alias": "my-keystore-alias", "debug": true, "expiration": "2025-12-31T23:59:59.000Z" }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] } }]

Upload Android Credentials

Upload a new android keystore for an organization. NOTE: you must be a manager in the organization to add new credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Upload Android Credentials"

orgid

string

required

No description

Request body for "Upload Android Credentials"

Media Type:

multipart/form-data

label

string

required

Label for the uploaded credentials

alias

string

required

Keystore alias

keypass

string

required

Keystore keypass

storepass

string

required

Keystore storepass

file

string

required

Keystore file

HTTP response status codes for "Upload Android Credentials":

Created

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Upload Android Credentials":

Request example

curl -X POST \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: multipart/form-data" \ -d '{"label":"string","alias":"string","keypass":"string","storepass":"string","file":"string"}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/credentials/signing/android"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "keystore": { "alias": "my-keystore-alias", "debug": true, "expiration": "2025-12-31T23:59:59.000Z" }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Delete and Regenerate Android Debug Credentials for organization

Delete and regenerate android debug credentials for an organization. NOTE: you must be a manager in the organization to delete credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Delete and Regenerate Android Debug Credentials for organization"

orgid

string

required

No description

HTTP response status codes for "Delete and Regenerate Android Debug Credentials for organization":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Delete and Regenerate Android Debug Credentials for organization":

Request example

curl -X DELETE \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/credentials/signing/android"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "keystore": { "alias": "my-keystore-alias", "debug": true, "expiration": "2025-12-31T23:59:59.000Z" }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Get All iOS Credentials

Get all credentials available for the project. A user in the projects org will see all credentials uploaded for any project within the org, whereas a user with project-level permissions will only see credentials assigned to the specific project.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get All iOS Credentials"

orgid

string

required

No description

projectid

string

required

No description

HTTP response status codes for "Get All iOS Credentials":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get All iOS Credentials":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/credentials/signing/ios"

Response example

[ { "platform": "webgl", "label": "Beta Credentials", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2015-08-27T22:29:00.023Z", "lastMod": "2015-08-27T22:29:00.023Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "provisioningProfile": { "teamId": "teamId", "bundleId": "bundleId", "uuid": "uuid", "expiration": "2025-12-31T23:59:59.000Z", "isEnterpriseProfile": true, "type": "developer", "numDevices": 42, "uploaded": "uploaded", "provisionedDevices": [ "device1", "device2" ] }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] } }]

Upload iOS Credentials

Upload a new iOS certificate and provisioning profile for the project. NOTE: you must be a manager in the project's organization to add new credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Upload iOS Credentials"

orgid

string

required

No description

projectid

string

required

No description

Request body for "Upload iOS Credentials"

Media Type:

multipart/form-data

label

string

required

Label for the uploaded credentials

fileCertificate

string

required

Certificate file (.p12)

fileProvisioningProfile

string

required

Provisioning Profile (.mobileprovision)

certificatePass

string

Certificate (.p12) password

HTTP response status codes for "Upload iOS Credentials":

Created

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Upload iOS Credentials":

Request example

curl -X POST \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: multipart/form-data" \ -d '{"label":"string","fileCertificate":"string","fileProvisioningProfile":"string","certificatePass":"string"}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/credentials/signing/ios"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "provisioningProfile": { "teamId": "teamId", "bundleId": "bundleId", "uuid": "uuid", "expiration": "2025-12-31T23:59:59.000Z", "isEnterpriseProfile": true, "type": "developer", "numDevices": 42, "uploaded": "uploaded", "provisionedDevices": [ "device1", "device2" ] }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Get All iOS Credentials for an oganization

Get all credentials available for the project. A user in the projects org will see all credentials uploaded for any project within the org, whereas a user with project-level permissions will only see credentials assigned to the specific project.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get All iOS Credentials for an oganization"

orgid

string

required

No description

HTTP response status codes for "Get All iOS Credentials for an oganization":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get All iOS Credentials for an oganization":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/credentials/signing/ios"

Response example

[ { "platform": "webgl", "label": "Beta Credentials", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2015-08-27T22:29:00.023Z", "lastMod": "2015-08-27T22:29:00.023Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "provisioningProfile": { "teamId": "teamId", "bundleId": "bundleId", "uuid": "uuid", "expiration": "2025-12-31T23:59:59.000Z", "isEnterpriseProfile": true, "type": "developer", "numDevices": 42, "uploaded": "uploaded", "provisionedDevices": [ "device1", "device2" ] }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] } }]

Upload iOS Credentials for organization

Upload a new iOS certificate and provisioning profile for the organization. NOTE: you must be a manager in the organization to add new credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Upload iOS Credentials for organization"

orgid

string

required

No description

Request body for "Upload iOS Credentials for organization"

Media Type:

multipart/form-data

label

string

required

Label for the uploaded credentials

fileCertificate

string

required

Certificate file (.p12)

fileProvisioningProfile

string

required

Provisioning Profile (.mobileprovision)

certificatePass

string

Certificate (.p12) password

HTTP response status codes for "Upload iOS Credentials for organization":

Created

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Upload iOS Credentials for organization":

Request example

curl -X POST \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: multipart/form-data" \ -d '{"label":"string","fileCertificate":"string","fileProvisioningProfile":"string","certificatePass":"string"}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/credentials/signing/ios"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "provisioningProfile": { "teamId": "teamId", "bundleId": "bundleId", "uuid": "uuid", "expiration": "2025-12-31T23:59:59.000Z", "isEnterpriseProfile": true, "type": "developer", "numDevices": 42, "uploaded": "uploaded", "provisionedDevices": [ "device1", "device2" ] }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Get All OSX Credentials

Get all credentials available for the project. A user in the projects org will see all credentials uploaded for any project within the org, whereas a user with project-level permissions will only see credentials assigned to the specific project.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get All OSX Credentials"

orgid

string

required

No description

projectid

string

required

No description

HTTP response status codes for "Get All OSX Credentials":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get All OSX Credentials":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/credentials/signing/osx"

Response example

[ { "platform": "webgl", "label": "Beta Credentials", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2015-08-27T22:29:00.023Z", "lastMod": "2015-08-27T22:29:00.023Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "providerName": "Apple Developer", "appleIdUsername": "developer@example.com", "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] } }]

Upload OSX Credentials

Upload a new OSX certificate and provisioning profile for the project. NOTE: you must be a manager in the project's organization to add new credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Upload OSX Credentials"

orgid

string

required

No description

projectid

string

required

No description

Request body for "Upload OSX Credentials"

Media Type:

multipart/form-data

label

string

required

Label for the uploaded credentials

appleIdUsername

string

required

Apple ID Username

appleIdPassword

string

required

Apple ID Password

certificate

string

required

Certificate file (.p12)

certificatePass

string

Certificate (.p12) password

providerName

string

Provider Name

entitlementsFile

string

Entitlements file (.entitlements)

HTTP response status codes for "Upload OSX Credentials":

Created

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Upload OSX Credentials":

Request example

curl -X POST \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: multipart/form-data" \ -d '{"label":"string","appleIdUsername":"string","appleIdPassword":"string","certificate":"string","certificatePass":"string","providerName":"string","entitlementsFile":"string"}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/credentials/signing/osx"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "providerName": "Apple Developer", "appleIdUsername": "developer@example.com", "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Get All OSX Credentials for an oganization

Get all credentials available for the project. A user in the projects org will see all credentials uploaded for any project within the org, whereas a user with project-level permissions will only see credentials assigned to the specific project.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get All OSX Credentials for an oganization"

orgid

string

required

No description

HTTP response status codes for "Get All OSX Credentials for an oganization":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get All OSX Credentials for an oganization":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/credentials/signing/osx"

Response example

[ { "platform": "webgl", "label": "Beta Credentials", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2015-08-27T22:29:00.023Z", "lastMod": "2015-08-27T22:29:00.023Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "providerName": "Apple Developer", "appleIdUsername": "developer@example.com", "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] } }]

Upload OSX Credentials for organization

Upload a new OSX certificate and provisioning profile for the organization. NOTE: you must be a manager in the organization to add new credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Upload OSX Credentials for organization"

orgid

string

required

No description

Request body for "Upload OSX Credentials for organization"

Media Type:

multipart/form-data

label

string

required

Label for the uploaded credentials

appleIdUsername

string

required

Apple ID Username

appleIdPassword

string

required

Apple ID Password

certificate

string

required

Certificate file (.p12)

certificatePass

string

Certificate (.p12) password

providerName

string

Provider Name

entitlementsFile

string

Entitlements file (.entitlements)

HTTP response status codes for "Upload OSX Credentials for organization":

Created

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Upload OSX Credentials for organization":

Request example

curl -X POST \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: multipart/form-data" \ -d '{"label":"string","appleIdUsername":"string","appleIdPassword":"string","certificate":"string","certificatePass":"string","providerName":"string","entitlementsFile":"string"}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/credentials/signing/osx"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "providerName": "Apple Developer", "appleIdUsername": "developer@example.com", "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Get All UWP Credentials

Get all credentials available for the project. A user in the projects org will see all credentials uploaded for any project within the org, whereas a user with project-level permissions will only see credentials assigned to the specific project.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get All UWP Credentials"

orgid

string

required

No description

projectid

string

required

No description

HTTP response status codes for "Get All UWP Credentials":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get All UWP Credentials":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/credentials/signing/uwp"

Response example

[ { "platform": "webgl", "label": "Beta Credentials", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2015-08-27T22:29:00.023Z", "lastMod": "2015-08-27T22:29:00.023Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] } }]

Upload UWP Credentials

Upload a new UWP certificate and provisioning profile for the project. NOTE: you must be a manager in the project's organization to add new credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Upload UWP Credentials"

orgid

string

required

No description

projectid

string

required

No description

Request body for "Upload UWP Credentials"

Media Type:

multipart/form-data

label

string

required

Label for the uploaded credentials

certificatePass

string

required

Certificate (.p12) password

certificate

string

required

Certificate file (.p12)

HTTP response status codes for "Upload UWP Credentials":

Created

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Upload UWP Credentials":

Request example

curl -X POST \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: multipart/form-data" \ -d '{"label":"string","certificatePass":"string","certificate":"string"}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/credentials/signing/uwp"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Get All UWP Credentials for an oganization

Get all credentials available for the project. A user in the projects org will see all credentials uploaded for any project within the org, whereas a user with project-level permissions will only see credentials assigned to the specific project.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get All UWP Credentials for an oganization"

orgid

string

required

No description

HTTP response status codes for "Get All UWP Credentials for an oganization":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get All UWP Credentials for an oganization":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/credentials/signing/uwp"

Response example

[ { "platform": "webgl", "label": "Beta Credentials", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2015-08-27T22:29:00.023Z", "lastMod": "2015-08-27T22:29:00.023Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] } }]

Upload UWP Credentials for organization

Upload a new UWP certificate and provisioning profile for the organization. NOTE: you must be a manager in the organization to add new credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Upload UWP Credentials for organization"

orgid

string

required

No description

Request body for "Upload UWP Credentials for organization"

Media Type:

multipart/form-data

label

string

required

Label for the uploaded credentials

certificatePass

string

required

Certificate (.p12) password

certificate

string

required

Certificate file (.p12)

HTTP response status codes for "Upload UWP Credentials for organization":

Created

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Upload UWP Credentials for organization":

Request example

curl -X POST \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: multipart/form-data" \ -d '{"label":"string","certificatePass":"string","certificate":"string"}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/credentials/signing/uwp"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Get Android Credential Details

Get specific android credential details

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get Android Credential Details"

orgid

string

required

No description

projectid

string

required

No description

credentialid

string

required

No description

HTTP response status codes for "Get Android Credential Details":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get Android Credential Details":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/credentials/signing/android/{credentialid}"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "keystore": { "alias": "my-keystore-alias", "debug": true, "expiration": "2025-12-31T23:59:59.000Z" }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Update Android Credentials

Update an android keystore for the project. NOTE: you must be a manager in the project's organization to add new credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Update Android Credentials"

orgid

string

required

No description

projectid

string

required

No description

credentialid

string

required

No description

Request body for "Update Android Credentials"

Media Type:

multipart/form-data

label

string

Label for the updated credentials

alias

string

Keystore alias

keypass

string

Keystore keypass

storepass

string

Keystore storepass

file

string

Keystore file

HTTP response status codes for "Update Android Credentials":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Update Android Credentials":

Request example

curl -X PUT \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: multipart/form-data" \ -d '{"label":"string","alias":"string","keypass":"string","storepass":"string","file":"string"}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/credentials/signing/android/{credentialid}"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "keystore": { "alias": "my-keystore-alias", "debug": true, "expiration": "2025-12-31T23:59:59.000Z" }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Delete Android Credentials

Delete specific android credentials for a project. NOTE: you must be a manager in the project's organization to delete credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Delete Android Credentials"

orgid

string

required

No description

projectid

string

required

No description

credentialid

string

required

No description

HTTP response status codes for "Delete Android Credentials":

No Content

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Delete Android Credentials":

Request example

curl -X DELETE \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/credentials/signing/android/{credentialid}"

Response example

{ "requestId": "string", "details": [ {} ], "detail": "string", "type": "string", "code": 0, "title": "string", "status": 0}

Get Android Credential Details for organization

Get specific organization android credential details

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get Android Credential Details for organization"

orgid

string

required

No description

credentialid

string

required

No description

HTTP response status codes for "Get Android Credential Details for organization":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get Android Credential Details for organization":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/credentials/signing/android/{credentialid}"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "keystore": { "alias": "my-keystore-alias", "debug": true, "expiration": "2025-12-31T23:59:59.000Z" }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Update Android Credentials for organization

Update an android keystore for the organization. NOTE: you must be a manager in the organization to update credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Update Android Credentials for organization"

orgid

string

required

No description

credentialid

string

required

No description

Request body for "Update Android Credentials for organization"

Media Type:

multipart/form-data

label

string

Label for the updated credentials

alias

string

Keystore alias

keypass

string

Keystore keypass

storepass

string

Keystore storepass

file

string

Keystore file

HTTP response status codes for "Update Android Credentials for organization":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Update Android Credentials for organization":

Request example

curl -X PUT \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: multipart/form-data" \ -d '{"label":"string","alias":"string","keypass":"string","storepass":"string","file":"string"}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/credentials/signing/android/{credentialid}"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "keystore": { "alias": "my-keystore-alias", "debug": true, "expiration": "2025-12-31T23:59:59.000Z" }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Delete Android Credentials for organization

Delete specific android credentials for an organization. NOTE: you must be a manager in the organization to delete credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Delete Android Credentials for organization"

orgid

string

required

No description

credentialid

string

required

No description

HTTP response status codes for "Delete Android Credentials for organization":

No Content

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Delete Android Credentials for organization":

Request example

curl -X DELETE \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/credentials/signing/android/{credentialid}"

Response example

{ "requestId": "string", "details": [ {} ], "detail": "string", "type": "string", "code": 0, "title": "string", "status": 0}

Get iOS Credential Details

Get specific iOS credential details

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get iOS Credential Details"

orgid

string

required

No description

projectid

string

required

No description

credentialid

string

required

No description

HTTP response status codes for "Get iOS Credential Details":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get iOS Credential Details":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/credentials/signing/ios/{credentialid}"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "provisioningProfile": { "teamId": "teamId", "bundleId": "bundleId", "uuid": "uuid", "expiration": "2025-12-31T23:59:59.000Z", "isEnterpriseProfile": true, "type": "developer", "numDevices": 42, "uploaded": "uploaded", "provisionedDevices": [ "device1", "device2" ] }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Update iOS Credentials

Update an iOS certificate / provisioning profile for the project. NOTE: you must be a manager in the project's organization to update credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Update iOS Credentials"

orgid

string

required

No description

projectid

string

required

No description

credentialid

string

required

No description

Request body for "Update iOS Credentials"

Media Type:

multipart/form-data

label

string

Label for the updated credentials

certificatePass

string

Certificate (.p12) password

fileCertificate

string

Certificate file (.p12)

fileProvisioningProfile

string

Provisioning Profile (.mobileprovision)

HTTP response status codes for "Update iOS Credentials":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Update iOS Credentials":

Request example

curl -X PUT \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: multipart/form-data" \ -d '{"label":"string","certificatePass":"string","fileCertificate":"string","fileProvisioningProfile":"string"}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/credentials/signing/ios/{credentialid}"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "provisioningProfile": { "teamId": "teamId", "bundleId": "bundleId", "uuid": "uuid", "expiration": "2025-12-31T23:59:59.000Z", "isEnterpriseProfile": true, "type": "developer", "numDevices": 42, "uploaded": "uploaded", "provisionedDevices": [ "device1", "device2" ] }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Delete iOS Credentials

Delete specific ios credentials for a project. NOTE: you must be a manager in the project's organization to delete credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Delete iOS Credentials"

orgid

string

required

No description

projectid

string

required

No description

credentialid

string

required

No description

HTTP response status codes for "Delete iOS Credentials":

No Content

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Delete iOS Credentials":

Request example

curl -X DELETE \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/credentials/signing/ios/{credentialid}"

Response example

{ "requestId": "string", "details": [ {} ], "detail": "string", "type": "string", "code": 0, "title": "string", "status": 0}

Get iOS Credential Details for organization

Get specific iOS credential details

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get iOS Credential Details for organization"

orgid

string

required

No description

credentialid

string

required

No description

HTTP response status codes for "Get iOS Credential Details for organization":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get iOS Credential Details for organization":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/credentials/signing/ios/{credentialid}"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "provisioningProfile": { "teamId": "teamId", "bundleId": "bundleId", "uuid": "uuid", "expiration": "2025-12-31T23:59:59.000Z", "isEnterpriseProfile": true, "type": "developer", "numDevices": 42, "uploaded": "uploaded", "provisionedDevices": [ "device1", "device2" ] }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Update iOS Credentials for organization

Update an iOS certificate / provisioning profile. NOTE: you must be a manager in the project's organization to update credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Update iOS Credentials for organization"

orgid

string

required

No description

credentialid

string

required

No description

Request body for "Update iOS Credentials for organization"

Media Type:

multipart/form-data

label

string

Label for the updated credentials

certificatePass

string

Certificate (.p12) password

fileCertificate

string

Certificate file (.p12)

fileProvisioningProfile

string

Provisioning Profile (.mobileprovision)

HTTP response status codes for "Update iOS Credentials for organization":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Update iOS Credentials for organization":

Request example

curl -X PUT \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: multipart/form-data" \ -d '{"label":"string","certificatePass":"string","fileCertificate":"string","fileProvisioningProfile":"string"}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/credentials/signing/ios/{credentialid}"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "provisioningProfile": { "teamId": "teamId", "bundleId": "bundleId", "uuid": "uuid", "expiration": "2025-12-31T23:59:59.000Z", "isEnterpriseProfile": true, "type": "developer", "numDevices": 42, "uploaded": "uploaded", "provisionedDevices": [ "device1", "device2" ] }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Delete iOS Credentials for organization

Delete specific ios credentials. NOTE: you must be a manager in the project's organization to delete credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Delete iOS Credentials for organization"

orgid

string

required

No description

credentialid

string

required

No description

HTTP response status codes for "Delete iOS Credentials for organization":

No Content

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Delete iOS Credentials for organization":

Request example

curl -X DELETE \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/credentials/signing/ios/{credentialid}"

Response example

{ "requestId": "string", "details": [ {} ], "detail": "string", "type": "string", "code": 0, "title": "string", "status": 0}

Get OSX Credential Details

Get specific OSX credential details

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get OSX Credential Details"

orgid

string

required

No description

projectid

string

required

No description

credentialid

string

required

No description

HTTP response status codes for "Get OSX Credential Details":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get OSX Credential Details":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/credentials/signing/osx/{credentialid}"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "providerName": "Apple Developer", "appleIdUsername": "developer@example.com", "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Update OSX Credentials

Update an OSX certificate / provisioning profile for the project. NOTE: you must be a manager in the project's organization to update credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Update OSX Credentials"

orgid

string

required

No description

projectid

string

required

No description

credentialid

string

required

No description

Request body for "Update OSX Credentials"

Media Type:

multipart/form-data

label

string

Label for the updated credentials

appleIdUsername

string

Apple ID Username

appleIdPassword

string

Apple ID Password

certificatePass

string

Certificate (.p12) password

providerName

string

Provider Name

certificate

string

Certificate file (.p12)

entitlementsFile

string

Entitlements file (.entitlements)

HTTP response status codes for "Update OSX Credentials":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Update OSX Credentials":

Request example

curl -X PUT \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: multipart/form-data" \ -d '{"label":"string","appleIdUsername":"string","appleIdPassword":"string","certificatePass":"string","providerName":"string","certificate":"string","entitlementsFile":"string"}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/credentials/signing/osx/{credentialid}"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "providerName": "Apple Developer", "appleIdUsername": "developer@example.com", "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Delete OSX Credentials

Delete specific OSX credentials for a project. NOTE: you must be a manager in the project's organization to delete credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Delete OSX Credentials"

orgid

string

required

No description

projectid

string

required

No description

credentialid

string

required

No description

HTTP response status codes for "Delete OSX Credentials":

No Content

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Delete OSX Credentials":

Request example

curl -X DELETE \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/credentials/signing/osx/{credentialid}"

Response example

{ "requestId": "string", "details": [ {} ], "detail": "string", "type": "string", "code": 0, "title": "string", "status": 0}

Get OSX Credential Details for organization

Get specific OSX credential details

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get OSX Credential Details for organization"

orgid

string

required

No description

credentialid

string

required

No description

HTTP response status codes for "Get OSX Credential Details for organization":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get OSX Credential Details for organization":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/credentials/signing/osx/{credentialid}"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "providerName": "Apple Developer", "appleIdUsername": "developer@example.com", "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Update OSX Credentials for organization

Update an OSX certificate / provisioning profile. NOTE: you must be a manager in the project's organization to update credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Update OSX Credentials for organization"

orgid

string

required

No description

credentialid

string

required

No description

Request body for "Update OSX Credentials for organization"

Media Type:

multipart/form-data

label

string

Label for the updated credentials

appleIdUsername

string

Apple ID Username

appleIdPassword

string

Apple ID Password

certificatePass

string

Certificate (.p12) password

providerName

string

Provider Name

certificate

string

Certificate file (.p12)

entitlementsFile

string

Entitlements file (.entitlements)

HTTP response status codes for "Update OSX Credentials for organization":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Update OSX Credentials for organization":

Request example

curl -X PUT \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: multipart/form-data" \ -d '{"label":"string","appleIdUsername":"string","appleIdPassword":"string","certificatePass":"string","providerName":"string","certificate":"string","entitlementsFile":"string"}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/credentials/signing/osx/{credentialid}"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "providerName": "Apple Developer", "appleIdUsername": "developer@example.com", "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Delete OSX Credentials for organization

Delete specific OSX credentials. NOTE: you must be a manager in the project's organization to delete credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Delete OSX Credentials for organization"

orgid

string

required

No description

credentialid

string

required

No description

HTTP response status codes for "Delete OSX Credentials for organization":

No Content

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Delete OSX Credentials for organization":

Request example

curl -X DELETE \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/credentials/signing/osx/{credentialid}"

Response example

{ "requestId": "string", "details": [ {} ], "detail": "string", "type": "string", "code": 0, "title": "string", "status": 0}

Get UWP Credential Details

Get specific UWP credential details

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get UWP Credential Details"

orgid

string

required

No description

projectid

string

required

No description

credentialid

string

required

No description

HTTP response status codes for "Get UWP Credential Details":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get UWP Credential Details":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/credentials/signing/uwp/{credentialid}"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Update UWP Credentials

Update an UWP certificate / provisioning profile for the project. NOTE: you must be a manager in the project's organization to update credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Update UWP Credentials"

orgid

string

required

No description

projectid

string

required

No description

credentialid

string

required

No description

Request body for "Update UWP Credentials"

Media Type:

multipart/form-data

label

string

Label for the updated credentials

certificatePass

string

Certificate (.p12) password

certificate

string

Certificate file (.p12)

HTTP response status codes for "Update UWP Credentials":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Update UWP Credentials":

Request example

curl -X PUT \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: multipart/form-data" \ -d '{"label":"string","certificatePass":"string","certificate":"string"}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/credentials/signing/uwp/{credentialid}"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Delete UWP Credentials

Delete specific UWP credentials for a project. NOTE: you must be a manager in the project's organization to delete credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Delete UWP Credentials"

orgid

string

required

No description

projectid

string

required

No description

credentialid

string

required

No description

HTTP response status codes for "Delete UWP Credentials":

No Content

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Delete UWP Credentials":

Request example

curl -X DELETE \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/credentials/signing/uwp/{credentialid}"

Response example

{ "requestId": "string", "details": [ {} ], "detail": "string", "type": "string", "code": 0, "title": "string", "status": 0}

Get UWP Credential Details for organization

Get specific UWP credential details

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Get UWP Credential Details for organization"

orgid

string

required

No description

credentialid

string

required

No description

HTTP response status codes for "Get UWP Credential Details for organization":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Get UWP Credential Details for organization":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/credentials/signing/uwp/{credentialid}"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Update UWP Credentials for organization

Update an UWP certificate / provisioning profile. NOTE: you must be a manager in the project's organization to update credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Update UWP Credentials for organization"

orgid

string

required

No description

credentialid

string

required

No description

Request body for "Update UWP Credentials for organization"

Media Type:

multipart/form-data

label

string

Label for the updated credentials

certificatePass

string

Certificate (.p12) password

certificate

string

Certificate file (.p12)

HTTP response status codes for "Update UWP Credentials for organization":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Update UWP Credentials for organization":

Request example

curl -X PUT \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: multipart/form-data" \ -d '{"label":"string","certificatePass":"string","certificate":"string"}' \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/credentials/signing/uwp/{credentialid}"

Response example

{ "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "certificate": { "teamId": "teamId", "certName": "certName", "expiration": "2025-12-31T23:59:59.000Z", "isDistribution": true, "issuer": "issuer", "uploaded": "2024-01-01T00:00:00Z" }, "links": { "self": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "delete": { "method": "get", "href": "/some/path/to/resource", "type": "application/json", "meta": {}, "redirect": false }, "projects": [ { "method": "get", "href": "/orgs/{orgFk}/projects/{guid}/", "meta": { "name": "My project", "id": "project-core-guid" } } ] }}

Delete UWP Credentials for organization

Delete specific UWP credentials. NOTE: you must be a manager in the project's organization to delete credentials.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "Delete UWP Credentials for organization"

orgid

string

required

No description

credentialid

string

required

No description

HTTP response status codes for "Delete UWP Credentials for organization":

No Content

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Delete UWP Credentials for organization":

Request example

curl -X DELETE \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/credentials/signing/uwp/{credentialid}"

Response example

{ "requestId": "string", "details": [ {} ], "detail": "string", "type": "string", "code": 0, "title": "string", "status": 0}

Retrieves all changelog lines with page-based pagination

Get Unity Build Automation changelogs

Query parameters for "Retrieves all changelog lines with page-based pagination"

per_page

integer

default: 25

example: 25

The maximum number of items to return in a single request

page

integer

default: 1

example: 1

The page number to return

logType

string

example: unity

Filter by specific changelog type (e.g., 'unity', 'xcode')

search

string

example: 2022.3

Search term to filter changelog messages

HTTP response status codes for "Retrieves all changelog lines with page-based pagination":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "Retrieves all changelog lines with page-based pagination":

Request example

curl -X GET \ "https://build-automation.services.api.unity.com/v2/changelogs"

Response example

[ { "logType": "unity", "message": "Unity 2022.3.15f1 is now available", "created": "2023-11-20T17:01:32.774Z", "releaseVersion": "2026_07_R2" }]

List cache compression levels for projects and build targets

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "List cache compression levels for projects and build targets"

orgid

string

required

No description

projectid

string

required

No description

HTTP response status codes for "List cache compression levels for projects and build targets":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "List cache compression levels for projects and build targets":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/versions/cache_compression_levels"

Response example

[ { "name": "my-project", "levels": [ { "level": "1", "label": "Fast", "isDefault": true } ] }]

List all build targets for a project

Gets all configured build targets for a project, regardless of whether they are enabled. Add "?include=settings,credentials" as a query parameter to include the build target settings and credentials with the response.

Authorizations

basicAuth

HTTP: basicAuth

HTTP Authorization Scheme: basic

jwt

HTTP: jwt

HTTP Authorization Scheme: bearer

Path parameters for "List all build targets for a project"

orgid

string

required

No description

projectid

string

required

No description

Query parameters for "List all build targets for a project"

include

array

example: settings,credentials

No description

limit

integer

No description

offset

integer

No description

lastBuiltUnityVersion

string

No description

operatingSystem

string

No description

search

string

No description

sortby

array

example: name,-created

No description

platform

No description

branch

string

No description

xcodeVersion

string

No description

androidVersion

string

No description

unityVersion

string

No description

osVersion

string

No description

buildTargetName

string

No description

createdBy

No description

groupName

string

No description

include_last_success

boolean

No description

filterForCacheCopy

boolean

No description

scenePreview

boolean

Filter to only scene-preview (true) or non-scene-preview (false) build targets.

HTTP response status codes for "List all build targets for a project":

OK

4XX

Client Side Error

5XX

Server Side Error

Code samples for "List all build targets for a project":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/buildtargets"

Response example

[ { "guid": "string", "name": "John Doe", "createdBy": "user@example.com", "platform": "webgl", "targetType": "normal", "buildtargetid": "ios", "enabled": true, "generateProjectPreview3D": false, "scenePreview": false, "settings": { "autoBuildLatest": "inherit", "autoBuild": true, "unityVersion": "2022.3.0f1", "autoDetectUnityVersion": true, "fallbackPatchVersion": true, "ccdEnabled": true, "ccdBucketId": "my-bucket-name", "ccdEnvironmentId": "production", "ccdApiKey": "api-key-12345", "ccdStripRemotePath": true, "ccdPreserveBucket": true, "ccdCreateRelease": true, "executablename": "MyApp", "buildProfilePath": "~/buildprofiles/buildprofile.json", "scm": { "type": "git", "url": "url", "url_buildjob": "https://git.internal.example.com/org/repo.git", "user": "user", "pass": "pass", "fingerprint": "fingerprint", "p4authtype": "p4authtype", "authType": "UPWorkingMode", "plasticAccessToken": "plasticAccessToken", "shallowclone": true, "windowsGitBinary": "cygwin", "useEncryption": true, "encryptionKey": "a1b2c3d4e5f6g7h8i9j0", "encryptionMethod": "AES128", "plasticEnvironment": "prd", "oauth": { "scm_provider": "scm_provider", "temp_state": "temp_state", "github": { "repository": null, "token": null, "refreshToken": null, "expiration": null, "expirationInterval": null }, "gitlab": { "repository": null, "token": null, "refreshToken": null, "expiration": null, "expirationInterval": null }, "bitbucket": { "repository": null, "token": null, "refreshToken": null, "expiration": null, "expirationInterval": null, "workspace": null }, "azure": { "repository": null, "token": null, "refreshToken": null, "expiration": null, "expirationInterval": null, "azureOrg": null, "azureProject": null } }, "isUnityCloudDrive": true, "repo": "repo", "branch": "branch", "subdirectory": "subdirectory", "client": "client" }, "platform": { "bundleId": "bundleId", "xcodeVersion": "xcodeVersion" }, "buildSchedule": { "isEnabled": false, "date": "2000-01-23T04:56:07.000+00:00", "repeatCycle": "once", "cronScheduleString": "cronScheduleString", "cronScheduleTimezone": "cronScheduleTimezone", "cleanBuild": false, "skipBuildIfSameCommit": true }, "autoBuildCancellation": false, "machineTypeLabel": "Standard_v1", "operatingSystemSelected": "mac", "operatingSystemVersion": "sonomaSilicon", "rubyVersion": "3.2.0", "remoteCacheStrategy": "inherit", "windowsGitBinary": "inherit", "buildTargetCopyCache": "enabled", "architecture": "x86_64", "cacheCompressionLevel": "inherit", "artifactCompressionLevel": "inherit", "ignorePlasticCheckedInLibrary": true, "advanced": { "cache": { "compressionMethod": "compressionMethod" }, "xcode": { "useArchiveAndExport": true, "customFastlaneConfigPath": "customFastlaneConfigPath", "uploadXCArchive": true, "uploadXcodeProject": true, "shouldNotarize": true }, "android": { "buildAppBundle": true, "buildAssetPacks": true, "androidSDKVersion": "androidSDKVersion" }, "unity": { "preExportMethod": "preExportMethod", "postExportMethod": "postExportMethod", "preBuildScript": "preBuildScript", "postBuildScript": "postBuildScript", "preBuildScriptFailsBuild": true, "postBuildScriptFailsBuild": true, "scriptingDefineSymbols": "scriptingDefineSymbols", "playerExporter": { "sceneList": null, "buildOptions": null, "export": null }, "playerSettings": { "Android": null, "Switch": null }, "editorUserBuildSettings": { "androidBuildSystem": null, "standaloneBuildSubtarget": null, "switchCreateRomFile": null, "switchEnableRomCompression": null, "switchRomCompressionType": null, "switchRomCompressionLevel": null, "switchRomCompressionConfig": null, "switchSaveAdf": null, "switchGraphicsDebugging": null, "switchEnableHeapInspector": null, "switchEnableMemoryTracker": null, "switchWaitForMemoryTrackerOnStartup": null, "switchEnableDebugPad": null, "switchRedirectWritesToHostMount": null, "switchScriptingDebuggingTransport": null }, "assetBundles": { "buildBundles": null, "basePath": null, "buildAssetBundleOptions": null, "copyToStreamingAssets": null, "copyBundlePatterns": null, "uploadAssetBundles": null }, "addressables": { "buildAddressables": null, "uploadAddressables": null, "contentUpdate": null, "profileName": null, "failedAddressablesFailsBuild": null, "contentUpdateSettings": null, "generateBuildLayout": null, "buildLayoutReportFileFormat": null }, "runUnitTests": true, "runEditModeTests": true, "runPlayModeTests": true, "failedUnitTestFailsBuild": true, "unitTestMethod": "unitTestMethod", "disableAssemblyUpdater": true, "acceptApiUpdate": true, "enableLightBake": true }, "webGL": { "beautifulCorner": true, "beautifulCornerContent": true }, "uwp": { "windowsSDKVersion": "10.0.17134.0", "visualStudioVersion": "2019", "wsaArchitecture": "ARM", "capabilities": [ "EnterpriseAuthentication", "InternetClient" ], "targetFamily": [ "Universal", "Desktop" ], "buildType": "D3D", "msbuildConfiguration": "Debug", "platforms": [ "x64", "x86" ], "publishVisualStudioSolution": true }, "gamecorescarlett": { "packageEncryption": "development", "deploymentMethod": "push", "buildSubtarget": "development" }, "ps5": { "buildType": "PC Hosted", "workspaceName": "workspaceName", "buildCompressionType": "Default", "buildCompressionLevel": 3, "sdkVersion": "sdkVersion", "generateGamePatch": true, "autoIncrementContentVersion": true }, "generateGamePatch": true, "autoIncrementBuildVersion": true, "generateDlc": true, "dlcs": [ { "name": null, "value": null } ] } }, "buildTargetGroups": [ { "id": "id", "name": "John Doe", "description": "description", "created": "2000-01-23T04:56:07.000+00:00", "lastModified": "2000-01-23T04:56:07.000+00:00", "deleted": false, "enabled": true, "buildTargets": [ { "buildTargetId": null, "name": null, "enabled": null, "platform": null, "builderOperatingSystem": null } ] } ], "lastBuilt": { "unityVersion": "2022.3.0f1" }, "credentials": { "signing": { "credentialid": "credential-id-123", "credentialResourceRef": { "platform": "webgl", "label": "Production Build", "credentialid": "a7dba621-a877-43c5-8163-bda58247124e", "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "certificate": { "teamId": null, "certName": null, "expiration": null, "isDistribution": null, "issuer": null, "uploaded": null }, "provisioningProfile": { "teamId": null, "bundleId": null, "uuid": null, "expiration": null, "isEnterpriseProfile": null, "type": null, "numDevices": null, "uploaded": null, "provisionedDevices": null }, "keystore": { "alias": null, "debug": null, "expiration": null }, "links": { "self": null, "delete": null, "projects": null } } } }, "builds": [ { "build": 42, "buildtargetid": "ios", "buildTargetName": "Build Target Name", "buildGUID": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "buildStatus": "unknown", "cleanBuild": true, "scenePreview": false, "failureDetails": [ { "displayName": null, "stage": null, "step": null, "publicMessage": null, "link": null, "logline": null, "label": null, "failureType": null, "failureIndicatorLabel": null, "stageMatch": null } ], "canceledBy": "api", "causedBy": "api", "causedByUser": "John Doe", "causedByServiceAccountId": "1c4c5981-3aea-4c0a-aec7-47205886a098", "buildProfilePath": "~/buildprofiles/buildprofile.json", "platform": "webgl", "formattedPlatformName": "iOS", "editorIcon": "ios_editor_icon.png", "workspaceSize": 1048576, "created": "2025-11-08T12:00:00Z", "finished": "2025-11-08T12:00:00Z", "checkoutStartTime": "2025-11-08T12:00:00Z", "checkoutTimeInSeconds": 120, "buildStartTime": "2025-11-08T12:00:00Z", "buildTimeInSeconds": 300, "buildTimeoutMinutes": 0, "publishStartTime": "2025-11-08T12:00:00Z", "publishTimeInSeconds": 60, "totalTimeInSeconds": 600, "billableTimeInSeconds": 580, "unitTestTimeInSeconds": 90, "editModeTestTimeInSeconds": 30, "playModeTestTimeInSeconds": 45, "lastBuiltRevision": "abc123def456", "changeset": [ { "file": null, "action": null, "numAffectedFiles": null, "commitId": null, "timestamp": null, "author": null, "message": null } ], "favorited": true, "label": "Production Build", "deleted": true, "deletedArtifacts": true, "deletedLogs": true, "deletedDate": "2025-11-08T12:00:00Z", "headless": true, "credentialsOutdated": true, "groupBuildId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "buildTargetGroups": [ { "id": null, "name": null, "description": null, "created": null, "lastModified": null, "deleted": null, "enabled": null, "buildTargets": null } ], "machineType": { "name": "Standard_v1", "shortName": "win_standard_v1", "label": "win_standard_v1", "operatingSystem": "mac", "operatingSystemVersions": [ "sonomaSilicon", "venturaIntel" ], "enabled": true, "default": false, "isBestValue": true, "freeTierEligible": true, "sku": "Standard_D2s_v3", "cpuCores": 2, "memoryGB": 8, "videoMemoryGB": 1, "diskSizeGB": 100, "osDiskSizeGB": 30, "dataDriveType": "pooled" }, "deletedBy": "user@example.com", "deletedByRetentionPolicy": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "queuedReason": "sentToBuilder", "cooldownDate": "2025-11-08T12:00:00Z", "scmBranch": "main", "unityVersion": "2022.3.0f1", "localUnityVersion": "2022.3.0f1", "architecture": "AppleIntel", "operatingSystemVersion": "monterey", "operatingSystem": "mac", "xcodeVersion": "xcode13_0_0", "androidSdkVersion": "android_sdk_34", "auditChanges": 3, "projectVersion": { "name": "John Doe", "filename": "filename", "projectName": "projectName", "platform": "webgl", "size": 1048576, "created": "2023-01-01T00:00:00Z", "lastMod": "2023-01-01T00:00:00Z", "bundleId": "bundleId", "udids": [ "device1", "device2" ], "links": {} }, "projectName": "Project Name", "projectId": "1234567890", "projectGuid": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "orgId": "1234567890", "orgFk": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "filetoken": "1234567890", "links": { "self": { "method": null, "href": null, "type": null, "meta": null, "redirect": null }, "log": { "method": null, "href": null, "type": null, "meta": null, "redirect": null }, "auditlog": { "method": null, "href": null, "type": null, "meta": null, "redirect": null }, "cancel": { &

Unity Build Automation

Authentication

List all xcode versions

Path parameters for "List all xcode versions"

orgid

projectid

HTTP response status codes for "List all xcode versions":

200OK

4XXClient Side Error

5XXServer Side Error

Code samples for "List all xcode versions":

Request example

Response example

GET/orgs/{orgid}/projects/{projectid}/versions/xcode

List all visual studio versions for UWP applications

Path parameters for "List all visual studio versions for UWP applications"

orgid

projectid

HTTP response status codes for "List all visual studio versions for UWP applications":

200OK

4XXClient Side Error

5XXServer Side Error

Code samples for "List all visual studio versions for UWP applications":

Request example

Response example

GET/orgs/{orgid}/projects/{projectid}/versions/visual-studio

Get the currently authenticated user.

HTTP response status codes for "Get the currently authenticated user.":

200Ok

4XXClient Side Error

5XXServer Side Error

Code samples for "Get the currently authenticated user.":

Request example

Response example

GET/users/me

Update the current user's information specific to the Unity Build Automation service.

Request body for "Update the current user's information specific to the Unity Build Automation service."

disableNotifications

lastAcceptedEulaVersion

HTTP response status codes for "Update the current user's information specific to the Unity Build Automation service.":

200OK

4XXClient Side Error

5XXServer Side Error

Code samples for "Update the current user's information specific to the Unity Build Automation service.":

Request example

Response example

PUT/users/me

List all iOS device profiles for the current user

HTTP response status codes for "List all iOS device profiles for the current user":

200Ok

4XXClient Side Error

5XXServer Side Error

Code samples for "List all iOS device profiles for the current user":

Request example

Response example

GET/users/me/devices

Create a new iOS device profile for the current user

Request body for "Create a new iOS device profile for the current user"

udid

devicename

os

osversion

product

status

HTTP response status codes for "Create a new iOS device profile for the current user":

201Created

4XXClient Side Error

5XXServer Side Error

Code samples for "Create a new iOS device profile for the current user":

Request example

Response example

POST/users/me/devices

Get a unity version by value

Path parameters for "Get a unity version by value"

orgid

projectid

unityVersionValue

HTTP response status codes for "Get a unity version by value":

200OK

4XXClient Side Error