```json
{
"openapi": "3.0.0",
"paths": {
"/orgs/{orgid}/projects/{projectid}/versions/xcode": {
"get": {
"operationId": "XcodeVersionsController_listXcodeVersions",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/XcodeVersion"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "List all xcode versions",
"summary": "List all xcode versions",
"tags": [
"XcodeVersions"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/versions/visual-studio": {
"get": {
"operationId": "VisualStudioVersionsController_listVisualStudioVersions",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/VisualStudioVersionResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "List all visual studio versions for UWP applications",
"summary": "List all visual studio versions for UWP applications",
"tags": [
"VisualStudioVersions"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/users/me": {
"get": {
"operationId": "UsersController_getUser",
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get the currently authenticated user.",
"summary": "Get the currently authenticated user.",
"tags": [
"Users"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": []
},
"put": {
"operationId": "UsersController_updateUser",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Update the current user's information specific to the Unity Build Automation service.",
"summary": "Update the current user's information specific to the Unity Build Automation service.",
"tags": [
"Users"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateUserRequest"
}
}
}
}
}
},
"/users/me/devices": {
"get": {
"operationId": "UsersController_getUserDevices",
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/UserDevice"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "List all iOS device profiles for the current user",
"summary": "List all iOS device profiles for the current user",
"tags": [
"Users"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": []
},
"post": {
"operationId": "UsersController_createUserDevice",
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserDevice"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Create a new iOS device profile for the current user",
"summary": "Create a new iOS device profile for the current user",
"tags": [
"Users"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateUserDevice"
}
}
}
}
}
},
"/orgs/{orgid}/projects/{projectid}/versions/unity/{unityVersionValue}": {
"get": {
"operationId": "UnityVersionsController_getVersion",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetVersionResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get a unity version by value",
"summary": "Get a unity version by value",
"tags": [
"UnityVersions"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "unityVersionValue",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/versions/auto_detect_supported_scms": {
"get": {
"operationId": "UnityVersionsController_listScmsSupportingVersionAutoDetect",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"type": "string"
},
"type": "array"
},
"examples": {
"Example 1": {
"value": [
"git",
"svn"
]
}
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "List all SCM types supporting auto detecting the project Unity version",
"summary": "List all SCM types supporting auto detecting the project Unity version",
"tags": [
"UnityVersions"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/versions/unity": {
"get": {
"operationId": "UnityVersionsController_listUnityVersions",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/UnityVersionResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "List all unity versions",
"summary": "List all unity versions",
"tags": [
"UnityVersions"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "platform",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/status": {
"get": {
"operationId": "StatusController_getStatusInfo",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/StatusResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get Build Automation Status",
"summary": "Get Build Automation Status",
"tags": [
"Status"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": []
}
},
"/orgs/{orgid}/projects/{projectid}/scm/checkurl": {
"post": {
"operationId": "ScmController_checkUrl",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CheckUrlResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Check a url for connectivity",
"summary": "Check a url for connectivity",
"tags": [
"SCM"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "connectionId",
"required": false,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CheckUrlRequestBody"
}
}
}
}
}
},
"/orgs/{orgid}/projects/{projectid}/hooks/scm/commit": {
"post": {
"operationId": "ScmController_commit",
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommitResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Notify UCB that a commit has been made",
"summary": "Notify UCB that a commit has been made",
"tags": [
"SCM"
],
"deprecated": true,
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "x-hub-signature",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "x-gitlab-token",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "x-azure-token",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "x-github-event",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "x-gitlab-event",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "x-event-key",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "token",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Record_string.any_"
}
}
}
}
}
},
"/orgs/{orgid}/projects/{projectid}/scm/git/branches": {
"get": {
"operationId": "ScmController_gitListBranches",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"type": "string"
},
"type": "array"
},
"examples": {
"Example 1": {
"value": [
"main",
"develop"
]
}
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "List branches in the projects git repo",
"summary": "List branches in the projects git repo",
"tags": [
"SCM"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "connectionId",
"required": false,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/scm/p4/client/{client}": {
"get": {
"operationId": "ScmController_p4GetClient",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "string"
},
"examples": {
"Example 1": {
"value": "workspace-config"
}
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get client workspace in the projects p4 repo",
"summary": "Get client workspace in the projects p4 repo",
"tags": [
"SCM"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "client",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "connectionId",
"required": false,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/scm/p4/clients": {
"get": {
"operationId": "ScmController_p4ListClients",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"type": "string"
},
"type": "array"
},
"examples": {
"Example 1": {
"value": [
"client1",
"client2"
]
}
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "List clients in the projects p4 repo",
"summary": "List clients in the projects p4 repo",
"tags": [
"SCM"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "connectionId",
"required": false,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/scm/plastic/repos/{repo}/branches": {
"get": {
"operationId": "ScmController_plasticListBranchesForRepo",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"type": "string"
},
"type": "array"
},
"examples": {
"Example 1": {
"value": [
"main",
"develop"
]
}
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "List branches in the selected repo for the project",
"summary": "List branches in the selected repo for the project",
"tags": [
"SCM"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "repo",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "connectionId",
"required": false,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/scm/plastic/repos": {
"get": {
"operationId": "ScmController_plasticListRepos",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/PlasticRepoResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "List repos in the projects plastic server",
"summary": "List repos in the projects plastic server",
"tags": [
"SCM"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "connectionId",
"required": false,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/scm/svn/folders": {
"get": {
"operationId": "ScmController_svnListFolders",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"type": "string"
},
"type": "array"
},
"examples": {
"Example 1": {
"value": [
"trunk/folder1",
"trunk/folder2"
]
}
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "List folders in the projects svn repo",
"summary": "List folders in the projects svn repo",
"tags": [
"SCM"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "subfolder",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "connectionId",
"required": false,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/scenepreviews": {
"get": {
"operationId": "ScenePreviewController_getScenePreviews",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ScenePreviewResponse"
},
"type": "array"
}
}
},
"headers": {
"Content-Range": {
"schema": {
"type": "string"
},
"required": true
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Returns scene-preview build targets for the project (newest first by creation date, with id as a tiebreaker), each with its latest build attempt (any status) and its latest successful build. Pass limit/offset to paginate; every response includes a Content-Range header with the (inclusive) range returned and the total count.",
"summary": "List scene-preview build targets",
"tags": [
"ScenePreview"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"format": "int64",
"type": "integer",
"minimum": 1
},
"example": 10
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"format": "int64",
"type": "integer",
"minimum": 0
},
"example": 0
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/scenepreviews/{buildtargetid}": {
"get": {
"operationId": "ScenePreviewController_getScenePreview",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScenePreviewResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Returns one scene-preview build target with its latest build attempt (any status) and its latest successful build. Answers 404 both when the build target does not exist and when it exists but is not a scene-preview target. These are intended to be distinguished by the `code` in the error body; a distinct code for the not-a-scene-preview case is pending allocation by the gateway team, so both currently return NotFound (54).",
"summary": "Get a single scene-preview build target",
"tags": [
"ScenePreview"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/retentionpolicies": {
"get": {
"operationId": "RetentionPoliciesController_getRetentionPoliciesForProject",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/RetentionPolicyResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Returns a list of retention policies configured for the specified project.",
"summary": "Get retention policies for a project.",
"tags": [
"RetentionPolicy"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"post": {
"operationId": "RetentionPoliciesController_createRetentionPolicy",
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RetentionPolicyResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Creates a new retention policy with the specified configuration.",
"summary": "Create a retention policy for a project.",
"tags": [
"RetentionPolicy"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRetentionPolicyRequest"
}
}
}
}
}
},
"/orgs/{orgid}/projects/{projectid}/retentionpolicies/{retentionpolicyguid}": {
"get": {
"operationId": "RetentionPoliciesController_getRetentionPolicy",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RetentionPolicyResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Returns detailed information about a specific retention policy.",
"summary": "Get retention policy details.",
"tags": [
"RetentionPolicy"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "retentionpolicyguid",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
]
},
"put": {
"operationId": "RetentionPoliciesController_updateRetentionPolicy",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RetentionPolicyResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Updates an existing retention policy with new values.",
"summary": "Update a retention policy.",
"tags": [
"RetentionPolicy"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "retentionpolicyguid",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateRetentionPolicyRequest"
}
}
}
}
},
"delete": {
"operationId": "RetentionPoliciesController_deleteRetentionPolicy",
"responses": {
"204": {
"description": "No Content"
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Deletes a retention policy from a project.",
"summary": "Delete a retention policy.",
"tags": [
"RetentionPolicy"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "retentionpolicyguid",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}": {
"get": {
"operationId": "ProjectsController_getProject",
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Returns detailed information about a specific project.",
"summary": "Get project details.",
"tags": [
"Project"
],
"deprecated": true,
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Optional properties to return: `serviceFlags`. Omit this parameter to receive it; supply it without naming `serviceFlags` to leave it out. Values it does not recognise are ignored.",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
]
},
"put": {
"operationId": "ProjectsController_updateProject",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetProjectResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Update project details",
"summary": "Update project details",
"tags": [
"Project"
],
"deprecated": true,
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectRequestBody"
}
}
}
}
},
"delete": {
"operationId": "ProjectsController_archiveProject",
"responses": {
"204": {
"description": "No Content"
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "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.",
"summary": "Archive project",
"tags": [
"Project"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects": {
"get": {
"operationId": "ProjectsController_listProjectsForOrg",
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ProjectResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Returns the projects that belong to the specified organization.",
"summary": "List projects for an organization.",
"tags": [
"Project"
],
"deprecated": true,
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Optional properties to return: `settings`, `serviceFlags`. Omit this parameter to receive all of them; supply it to receive only the ones you name. Values it does not recognise are ignored.",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
]
}
},
"/projects/{projectid}": {
"get": {
"operationId": "ProjectsController_getProjectByProjectId",
"responses": {
"200": {
"description": "Detailed information about a specific project, identified by its project ID only (no org scope required).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get project by project ID",
"summary": "Get project details by project ID",
"tags": [
"Project"
],
"deprecated": true,
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/auditlog": {
"get": {
"operationId": "ProjectsController_getAuditLogForProject",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/AuditLogResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Retrieve a list of historical settings changes for this project",
"summary": "Get audit log",
"tags": [
"Project"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The maximum number of items to return in a single request",
"in": "query",
"name": "per_page",
"required": false,
"schema": {
"default": 25,
"format": "int64",
"type": "integer",
"minimum": 1
},
"example": 25
},
{
"description": "The page number to return",
"in": "query",
"name": "page",
"required": false,
"schema": {
"default": 1,
"format": "int64",
"type": "integer",
"minimum": 1
},
"example": 1
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/billingplan": {
"get": {
"operationId": "ProjectsController_getBillingPlansForProject",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetBillingPlansForProjectResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get the billing plan for the specified project",
"summary": "Get billing plan",
"tags": [
"Project"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "refresh",
"required": false,
"schema": {
"type": "boolean"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/sshkey": {
"get": {
"operationId": "ProjectsController_getSSHKeyForProject",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetSSHKeyForProjectResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get the ssh public key for the specified project",
"summary": "Get SSH Key",
"tags": [
"Project"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/sshkey/raw": {
"get": {
"operationId": "ProjectsController_getSSHKeyRaw",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetSSHKeyRawResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get Raw SSH Key",
"summary": "Get Raw SSH Key",
"tags": [
"Project"
],
"security": [
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "type",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/stats": {
"get": {
"operationId": "ProjectsController_getStatsForProject",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetStatsForProjectResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get statistics for the specified project",
"summary": "Get project statistics",
"tags": [
"Project"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "includeDeleted",
"required": false,
"schema": {
"type": "boolean"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/projectpreview": {
"get": {
"operationId": "ProjectPreviewController_getProjectPreview",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ProjectPreviewResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "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.",
"summary": "Query Project Preview build state",
"tags": [
"ProjectPreview"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "branch",
"required": false,
"schema": {
"type": "string"
},
"example": "main"
},
{
"in": "query",
"name": "repo",
"required": false,
"schema": {
"type": "string"
},
"example": "my-repo"
},
{
"in": "query",
"name": "platform",
"required": false,
"schema": {
"$ref": "#/components/schemas/Platform"
}
}
]
}
},
"/platforms/supported": {
"get": {
"operationId": "PlatformsController_listSupportedPlatforms",
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/SupportedPlatformResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Queries the database for the supported platforms and returns the list of supported platforms.",
"summary": "List supported platforms",
"tags": [
"Platforms"
],
"parameters": [
{
"in": "query",
"name": "unityVersion",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "platform",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/versions/sdk_config/{unityVersionValue}": {
"get": {
"operationId": "PlatformRequirementsController_getEntitledPlatformSdk",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"type": "string"
},
"type": "array"
},
"examples": {
"Example 1": {
"value": [
"5.0",
"6.0"
]
}
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get the Platform SDK requirements for the given Unity Version",
"summary": "Get the Platform SDK requirements for the given Unity Version",
"tags": [
"PlatformRequirements"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "unityVersionValue",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "platform",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/plastic/exchange": {
"post": {
"operationId": "PlasticController_exchangeToken",
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExchangeTokenResponse"
}
}
}
},
"404": {
"description": "Not Found - The credentials exchanged for no token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Exchanges for a Plastic token.",
"summary": "Exchanges for a Plastic token.",
"tags": [
"Plastic"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "header",
"name": "x-plastic",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "x-plastic-staging",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}": {
"get": {
"operationId": "OrgsController_getOrg",
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Returns detailed information about a specific organization.",
"summary": "Get organization details.",
"tags": [
"Orgs"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"patch": {
"operationId": "OrgsController_setOrgData",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetOrgDataResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Update specific data for the specified organization in UBA's cache",
"summary": "Update organization data",
"tags": [
"Orgs"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetOrgDataRequestBody"
}
}
}
}
}
},
"/orgs/{orgid}/billingplan": {
"get": {
"operationId": "OrgsController_getBillingPlans",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetBillingPlansResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get the billing plan for the specified organization",
"summary": "Get billing plan",
"tags": [
"Orgs"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "refresh",
"required": false,
"schema": {
"type": "boolean"
}
}
]
}
},
"/orgs/{orgid}/sshkey": {
"get": {
"operationId": "OrgsController_getSSHKeyForOrg",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetSSHKeyForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get the ssh public key for the specified org",
"summary": "Get SSH Key",
"tags": [
"Orgs"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"post": {
"operationId": "OrgsController_regenerateSSHKey",
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetSSHKeyForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Regenerate the ssh key for the specified org *WARNING* this is a destructive operation that will permanently remove your current SSH key.",
"summary": "Regenerate SSH Key",
"tags": [
"Orgs"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "type",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/concurrency-limit": {
"get": {
"operationId": "OrgsController_getConcurrencyLimit",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrgConcurrencyLimitResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get how many builds the organization can run at the same time.",
"summary": "Get concurrency limit",
"tags": [
"Orgs"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"put": {
"operationId": "OrgsController_setConcurrencyLimit",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrgConcurrencyLimitResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Set how many builds the organization can run at the same time. Builds beyond the limit stay queued.",
"summary": "Set concurrency limit",
"tags": [
"Orgs"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetOrgConcurrencyLimitRequestBody"
}
}
}
}
}
},
"/orgs/{orgid}/free-tier-status": {
"get": {
"operationId": "OrgsController_getFreeTierStatus",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FreeTierStatusResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Reports whether the organization has reached its free tier build limit.",
"summary": "Check free tier status",
"tags": [
"Orgs"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/unity-pipeline": {
"get": {
"operationId": "OrgsController_getUnityPipelineEnrollment",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnityPipelineEnrollmentResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Returns the Unity Pipeline enrollment status for the specified organization.",
"summary": "Get Unity Pipeline enrollment status",
"tags": [
"Orgs"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/versions/operatingsystem/{value}": {
"get": {
"operationId": "OperatingSystemVersionsController_getOperatingSystemVersion",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperatingSystemVersion"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get an operating system version by key",
"summary": "Get an operating system version by key",
"tags": [
"OperatingSystemVersions"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "value",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/versions/operatingsystem": {
"get": {
"operationId": "OperatingSystemVersionsController_listOperatingSystemVersions",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/OperatingSystemVersion"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "List all operating system versions",
"summary": "List all operating system versions",
"tags": [
"OperatingSystemVersions"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "family",
"required": false,
"schema": {
"$ref": "#/components/schemas/OperatingSystemFamily"
}
},
{
"in": "query",
"name": "version",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "unity_version",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "xcode_version",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/oauth/{key}/createwebhook": {
"post": {
"operationId": "OAuthController_oauthCreateWebhook",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Create a commit webhook for the configured repo",
"summary": "Create a commit webhook for the configured repo",
"tags": [
"OAuth"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "key",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "connectionId",
"required": false,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/oauth/{key}/branches": {
"get": {
"operationId": "OAuthController_oauthListBranches",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/BranchResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "List branches in the project's repository",
"summary": "List branches in the project's repository",
"tags": [
"OAuth"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "key",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "connectionId",
"required": false,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/oauth/{key}/repos": {
"get": {
"operationId": "OAuthController_oauthListRepos",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/RepoResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "List available repositories",
"summary": "List available repositories",
"tags": [
"OAuth"
],
"deprecated": true,
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "key",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/machinetypes": {
"get": {
"operationId": "MachineTypesController_listMachineTypes",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/MachineType"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "List all enabled machine types",
"summary": "List all enabled machine types",
"tags": [
"MachineTypes"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "operatingSystem",
"required": false,
"schema": {
"$ref": "#/components/schemas/OperatingSystemFamily"
}
},
{
"in": "query",
"name": "operatingSystemVersion",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}/failures": {
"get": {
"operationId": "FailuresController_getBuildFailures",
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetBuildFailuresResponse"
},
"examples": {
"Example 1": {
"value": {
"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"
}
]
}
}
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Returns active failure indicators for the given build attempt.",
"summary": "Get categorized failures for a specific build.",
"tags": [
"Failures"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "number",
"required": true,
"schema": {
"$ref": "#/components/schemas/PositiveInteger"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}/failures/feedback": {
"post": {
"operationId": "FailuresController_submitFailureFeedback",
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
},
"examples": {
"Example 1": {
"value": {
"success": true
}
}
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Allows users to mark a failure indicator as helpful or not helpful.",
"summary": "Submit feedback for a specific failure indicator.",
"tags": [
"Failures"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "number",
"required": true,
"schema": {
"$ref": "#/components/schemas/PositiveInteger"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FailureFeedbackRequest"
}
}
}
}
}
},
"/orgs/{orgid}/projects/{projectid}/failure-indicator-labels": {
"get": {
"operationId": "FailuresController_getProjectFailureIndicatorLabels",
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetFailureIndicatorLabelsResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Returns all unique failure indicator labels that have been detected for failures within the project.",
"summary": "Get failure indicator labels for a project.",
"tags": [
"Failures"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/failure-indicator-labels": {
"get": {
"operationId": "FailuresController_getBuildTargetFailureIndicatorLabels",
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetFailureIndicatorLabelsResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Returns unique failure indicator labels detected for failures within the build target.",
"summary": "Get failure indicator labels for a build target.",
"tags": [
"Failures"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/envvars": {
"get": {
"operationId": "EnvVarsController_getEnvVariablesForBuildTarget",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Record_string.string_"
},
"examples": {
"Example 1": {
"value": {
"API_URL": "https://build-api.cloud.unity3d.com/",
"FEATURE_FLAG": "true"
}
}
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get all configured environment variables for a given build target",
"summary": "Get environment variables",
"tags": [
"EnvVars"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"put": {
"operationId": "EnvVarsController_setEnvVariablesForBuildTarget",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Record_string.string_"
},
"examples": {
"Example 1": {
"value": {
"API_URL": "https://build-api.cloud.unity3d.com/",
"FEATURE_FLAG": "true"
}
}
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Set all configured environment variables for a given build target",
"summary": "Set environment variables",
"tags": [
"EnvVars"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Record_string.string_"
}
}
}
}
}
},
"/orgs/{orgid}/projects/{projectid}/envvars": {
"get": {
"operationId": "EnvVarsController_getEnvVariablesForProject",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Record_string.string_"
},
"examples": {
"Example 1": {
"value": {
"API_URL": "https://build-api.cloud.unity3d.com/",
"FEATURE_FLAG": "true"
}
}
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get all configured environment variables for a given project",
"summary": "Get environment variables",
"tags": [
"EnvVars"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"put": {
"operationId": "EnvVarsController_setEnvVariablesForProject",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Record_string.string_"
},
"examples": {
"Example 1": {
"value": {
"API_URL": "https://build-api.cloud.unity3d.com/",
"FEATURE_FLAG": "true"
}
}
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Set all configured environment variables for a given project",
"summary": "Set environment variables",
"tags": [
"EnvVars"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Record_string.string_"
}
}
}
}
}
},
"/orgs/{orgid}/projects/{projectid}/editor/config": {
"get": {
"operationId": "EditorController_getCombinedConfigurations",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCombinedConfigurationsResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get machine types, xcode versions, and operating system versions",
"summary": "Get machine types, xcode versions, and operating system versions",
"tags": [
"Editor"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "family",
"required": false,
"schema": {
"$ref": "#/components/schemas/OperatingSystemFamily"
}
},
{
"in": "query",
"name": "version",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "unity_version",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "xcode_version",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "operatingSystem",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "operatingSystemVersion",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/device/distribution/plist": {
"get": {
"operationId": "DeviceController_generatePlist",
"responses": {
"200": {
"description": "OK",
"content": {
"text/x-generic": {
"schema": {
"type": "string"
},
"examples": {
"Example 1": {
"value": "\n\n\n\tItems\n\t\n\n"
}
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "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`).",
"summary": "Generate a plist file for device distribution",
"tags": [
"Device"
],
"parameters": [
{
"description": "Pre-signed download URL for the IPA (`software-package` asset).",
"in": "query",
"name": "bundle",
"required": true,
"schema": {
"type": "string"
},
"example": "https://storage.googleapis.com/bucket/example-org/new-project/ios-builder-1.ipa?sig=abc"
},
{
"description": "iOS bundle identifier embedded in the IPA (e.g. `com.example.MyGame`).\n\nOlder iOS user agents (8.x) get `.ios8` appended server-side.",
"in": "query",
"name": "bundleid",
"required": true,
"schema": {
"type": "string"
},
"example": "com.example.MyGame"
},
{
"description": "Pre-signed URL for the 57x57 PNG icon shown by iOS during install.",
"in": "query",
"name": "icon",
"required": true,
"schema": {
"type": "string"
},
"example": "https://storage.googleapis.com/bucket/example-org/new-project/ios-builder-1-icon.png?sig=abc"
},
{
"description": "Display title shown by iOS during install (the project name).",
"in": "query",
"name": "projectName",
"required": true,
"schema": {
"type": "string"
},
"example": "My Game"
}
]
}
},
"/device/deviceid.mobileconfig": {
"get": {
"operationId": "DeviceController_getDeviceConfigurationPlist",
"responses": {
"200": {
"description": "OK",
"content": {
"application/x-apple-aspen-config": {
"schema": {
"type": "string"
},
"examples": {
"Example 1": {
"value": "\n\n\n\n"
}
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "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.",
"summary": "Get device configuration plist for a specific device ID",
"tags": [
"Device"
],
"parameters": []
}
},
"/device/profile_installation/callback": {
"post": {
"operationId": "DeviceController_handleProfileInstallationCallback",
"responses": {
"301": {
"description": "Redirect to dashboard registration URL"
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "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.",
"summary": "Handle iOS profile installation callback",
"tags": [
"Device"
],
"parameters": []
}
},
"/orgs/{orgid}/projects/{projectid}/credentials/signing/android": {
"get": {
"operationId": "CredentialsController_getAllAndroid",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/GetAllAndroidResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "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.",
"summary": "Get All Android Credentials",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"post": {
"operationId": "CredentialsController_addCredentialsAndroid",
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegenerateAndroidDebugCredentialsForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Upload a new android keystore for the project. NOTE: you must be a manager in the project's organization to add new credentials.",
"summary": "Upload Android Credentials",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label for the uploaded credentials"
},
"alias": {
"type": "string",
"description": "Keystore alias"
},
"keypass": {
"type": "string",
"description": "Keystore keypass"
},
"storepass": {
"type": "string",
"description": "Keystore storepass"
},
"file": {
"type": "string",
"format": "binary",
"description": "Keystore file"
}
},
"required": [
"label",
"alias",
"keypass",
"storepass",
"file"
]
}
}
}
}
}
},
"/orgs/{orgid}/credentials/signing/android": {
"get": {
"operationId": "CredentialsController_getAllAndroidForOrg",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/GetAllAndroidResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get all credentials available for the organization. A list of projects using a credential is included in the links element.",
"summary": "Get All Android Credentials for an organization",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"post": {
"operationId": "CredentialsController_addCredentialsAndroidForOrg",
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegenerateAndroidDebugCredentialsForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Upload a new android keystore for an organization. NOTE: you must be a manager in the organization to add new credentials.",
"summary": "Upload Android Credentials",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label for the uploaded credentials"
},
"alias": {
"type": "string",
"description": "Keystore alias"
},
"keypass": {
"type": "string",
"description": "Keystore keypass"
},
"storepass": {
"type": "string",
"description": "Keystore storepass"
},
"file": {
"type": "string",
"format": "binary",
"description": "Keystore file"
}
},
"required": [
"label",
"alias",
"keypass",
"storepass",
"file"
]
}
}
}
}
},
"delete": {
"operationId": "CredentialsController_regenerateAndroidDebugCredentialsForOrg",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegenerateAndroidDebugCredentialsForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Delete and regenerate android debug credentials for an organization. NOTE: you must be a manager in the organization to delete credentials.",
"summary": "Delete and Regenerate Android Debug Credentials for organization",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/credentials/signing/ios": {
"get": {
"operationId": "CredentialsController_getAllIos",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/GetAllIosResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "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.",
"summary": "Get All iOS Credentials",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"post": {
"operationId": "CredentialsController_addCredentialsIos",
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddCredentialsIosForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "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.",
"summary": "Upload iOS Credentials",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label for the uploaded credentials"
},
"fileCertificate": {
"type": "string",
"format": "binary",
"description": "Certificate file (.p12)"
},
"fileProvisioningProfile": {
"type": "string",
"format": "binary",
"description": "Provisioning Profile (.mobileprovision)"
},
"certificatePass": {
"type": "string",
"description": "Certificate (.p12) password"
}
},
"required": [
"label",
"fileCertificate",
"fileProvisioningProfile"
]
}
}
}
}
}
},
"/orgs/{orgid}/credentials/signing/ios": {
"get": {
"operationId": "CredentialsController_getAllIosForOrg",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/GetAllIosResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "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.",
"summary": "Get All iOS Credentials for an oganization",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"post": {
"operationId": "CredentialsController_addCredentialsIosForOrg",
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddCredentialsIosForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Upload a new iOS certificate and provisioning profile for the organization. NOTE: you must be a manager in the organization to add new credentials.",
"summary": "Upload iOS Credentials for organization",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label for the uploaded credentials"
},
"fileCertificate": {
"type": "string",
"format": "binary",
"description": "Certificate file (.p12)"
},
"fileProvisioningProfile": {
"type": "string",
"format": "binary",
"description": "Provisioning Profile (.mobileprovision)"
},
"certificatePass": {
"type": "string",
"description": "Certificate (.p12) password"
}
},
"required": [
"label",
"fileCertificate",
"fileProvisioningProfile"
]
}
}
}
}
}
},
"/orgs/{orgid}/projects/{projectid}/credentials/signing/osx": {
"get": {
"operationId": "CredentialsController_getAllOsx",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/GetAllOsxResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "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.",
"summary": "Get All OSX Credentials",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"post": {
"operationId": "CredentialsController_addCredentialsOsx",
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddCredentialsOsxForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "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.",
"summary": "Upload OSX Credentials",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label for the uploaded credentials"
},
"appleIdUsername": {
"type": "string",
"description": "Apple ID Username"
},
"appleIdPassword": {
"type": "string",
"description": "Apple ID Password"
},
"certificate": {
"type": "string",
"format": "binary",
"description": "Certificate file (.p12)"
},
"certificatePass": {
"type": "string",
"description": "Certificate (.p12) password"
},
"providerName": {
"type": "string",
"description": "Provider Name"
},
"entitlementsFile": {
"type": "string",
"format": "binary",
"description": "Entitlements file (.entitlements)"
}
},
"required": [
"label",
"appleIdUsername",
"appleIdPassword",
"certificate"
]
}
}
}
}
}
},
"/orgs/{orgid}/credentials/signing/osx": {
"get": {
"operationId": "CredentialsController_getAllOsxForOrg",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/GetAllOsxResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "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.",
"summary": "Get All OSX Credentials for an oganization",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"post": {
"operationId": "CredentialsController_addCredentialsOsxForOrg",
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddCredentialsOsxForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Upload a new OSX certificate and provisioning profile for the organization. NOTE: you must be a manager in the organization to add new credentials.",
"summary": "Upload OSX Credentials for organization",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label for the uploaded credentials"
},
"appleIdUsername": {
"type": "string",
"description": "Apple ID Username"
},
"appleIdPassword": {
"type": "string",
"description": "Apple ID Password"
},
"certificate": {
"type": "string",
"format": "binary",
"description": "Certificate file (.p12)"
},
"certificatePass": {
"type": "string",
"description": "Certificate (.p12) password"
},
"providerName": {
"type": "string",
"description": "Provider Name"
},
"entitlementsFile": {
"type": "string",
"format": "binary",
"description": "Entitlements file (.entitlements)"
}
},
"required": [
"label",
"appleIdUsername",
"appleIdPassword",
"certificate"
]
}
}
}
}
}
},
"/orgs/{orgid}/projects/{projectid}/credentials/signing/uwp": {
"get": {
"operationId": "CredentialsController_getAllUwp",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/GetAllUwpResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "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.",
"summary": "Get All UWP Credentials",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"post": {
"operationId": "CredentialsController_addCredentialsUwp",
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddCredentialsUwpForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "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.",
"summary": "Upload UWP Credentials",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label for the uploaded credentials"
},
"certificatePass": {
"type": "string",
"description": "Certificate (.p12) password"
},
"certificate": {
"type": "string",
"format": "binary",
"description": "Certificate file (.p12)"
}
},
"required": [
"label",
"certificatePass",
"certificate"
]
}
}
}
}
}
},
"/orgs/{orgid}/credentials/signing/uwp": {
"get": {
"operationId": "CredentialsController_getAllUwpForOrg",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/GetAllUwpResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "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.",
"summary": "Get All UWP Credentials for an oganization",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"post": {
"operationId": "CredentialsController_addCredentialsUwpForOrg",
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddCredentialsUwpForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Upload a new UWP certificate and provisioning profile for the organization. NOTE: you must be a manager in the organization to add new credentials.",
"summary": "Upload UWP Credentials for organization",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label for the uploaded credentials"
},
"certificatePass": {
"type": "string",
"description": "Certificate (.p12) password"
},
"certificate": {
"type": "string",
"format": "binary",
"description": "Certificate file (.p12)"
}
},
"required": [
"label",
"certificatePass",
"certificate"
]
}
}
}
}
}
},
"/orgs/{orgid}/projects/{projectid}/credentials/signing/android/{credentialid}": {
"get": {
"operationId": "CredentialsController_getOneAndroid",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegenerateAndroidDebugCredentialsForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get specific android credential details",
"summary": "Get Android Credential Details",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"put": {
"operationId": "CredentialsController_updateAndroid",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegenerateAndroidDebugCredentialsForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Update an android keystore for the project. NOTE: you must be a manager in the project's organization to add new credentials.",
"summary": "Update Android Credentials",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": false,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label for the updated credentials"
},
"alias": {
"type": "string",
"description": "Keystore alias"
},
"keypass": {
"type": "string",
"description": "Keystore keypass"
},
"storepass": {
"type": "string",
"description": "Keystore storepass"
},
"file": {
"type": "string",
"format": "binary",
"description": "Keystore file"
}
}
}
}
}
}
},
"delete": {
"operationId": "CredentialsController_deleteAndroid",
"responses": {
"204": {
"description": "No Content"
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Delete specific android credentials for a project. NOTE: you must be a manager in the project's organization to delete credentials.",
"summary": "Delete Android Credentials",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/credentials/signing/android/{credentialid}": {
"get": {
"operationId": "CredentialsController_getOneAndroidForOrg",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegenerateAndroidDebugCredentialsForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get specific organization android credential details",
"summary": "Get Android Credential Details for organization",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"put": {
"operationId": "CredentialsController_updateAndroidForOrg",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegenerateAndroidDebugCredentialsForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Update an android keystore for the organization. NOTE: you must be a manager in the organization to update credentials.",
"summary": "Update Android Credentials for organization",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": false,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label for the updated credentials"
},
"alias": {
"type": "string",
"description": "Keystore alias"
},
"keypass": {
"type": "string",
"description": "Keystore keypass"
},
"storepass": {
"type": "string",
"description": "Keystore storepass"
},
"file": {
"type": "string",
"format": "binary",
"description": "Keystore file"
}
}
}
}
}
}
},
"delete": {
"operationId": "CredentialsController_deleteAndroidForOrg",
"responses": {
"204": {
"description": "No Content"
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Delete specific android credentials for an organization. NOTE: you must be a manager in the organization to delete credentials.",
"summary": "Delete Android Credentials for organization",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/credentials/signing/ios/{credentialid}": {
"get": {
"operationId": "CredentialsController_getOneIos",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddCredentialsIosForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get specific iOS credential details",
"summary": "Get iOS Credential Details",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"put": {
"operationId": "CredentialsController_updateIos",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddCredentialsIosForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Update an iOS certificate / provisioning profile for the project. NOTE: you must be a manager in the project's organization to update credentials.",
"summary": "Update iOS Credentials",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": false,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label for the updated credentials"
},
"certificatePass": {
"type": "string",
"description": "Certificate (.p12) password"
},
"fileCertificate": {
"type": "string",
"format": "binary",
"description": "Certificate file (.p12)"
},
"fileProvisioningProfile": {
"type": "string",
"format": "binary",
"description": "Provisioning Profile (.mobileprovision)"
}
}
}
}
}
}
},
"delete": {
"operationId": "CredentialsController_deleteIos",
"responses": {
"204": {
"description": "No Content"
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Delete specific ios credentials for a project. NOTE: you must be a manager in the project's organization to delete credentials.",
"summary": "Delete iOS Credentials",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/credentials/signing/ios/{credentialid}": {
"get": {
"operationId": "CredentialsController_getOneIosForOrg",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddCredentialsIosForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get specific iOS credential details",
"summary": "Get iOS Credential Details for organization",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"put": {
"operationId": "CredentialsController_updateIosForOrg",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddCredentialsIosForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Update an iOS certificate / provisioning profile. NOTE: you must be a manager in the project's organization to update credentials.",
"summary": "Update iOS Credentials for organization",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": false,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label for the updated credentials"
},
"certificatePass": {
"type": "string",
"description": "Certificate (.p12) password"
},
"fileCertificate": {
"type": "string",
"format": "binary",
"description": "Certificate file (.p12)"
},
"fileProvisioningProfile": {
"type": "string",
"format": "binary",
"description": "Provisioning Profile (.mobileprovision)"
}
}
}
}
}
}
},
"delete": {
"operationId": "CredentialsController_deleteIosForOrg",
"responses": {
"204": {
"description": "No Content"
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Delete specific ios credentials. NOTE: you must be a manager in the project's organization to delete credentials.",
"summary": "Delete iOS Credentials for organization",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/credentials/signing/osx/{credentialid}": {
"get": {
"operationId": "CredentialsController_getOneOsx",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddCredentialsOsxForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get specific OSX credential details",
"summary": "Get OSX Credential Details",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"put": {
"operationId": "CredentialsController_updateOsx",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddCredentialsOsxForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Update an OSX certificate / provisioning profile for the project. NOTE: you must be a manager in the project's organization to update credentials.",
"summary": "Update OSX Credentials",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": false,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label for the updated credentials"
},
"appleIdUsername": {
"type": "string",
"description": "Apple ID Username"
},
"appleIdPassword": {
"type": "string",
"description": "Apple ID Password"
},
"certificatePass": {
"type": "string",
"description": "Certificate (.p12) password"
},
"providerName": {
"type": "string",
"description": "Provider Name"
},
"certificate": {
"type": "string",
"format": "binary",
"description": "Certificate file (.p12)"
},
"entitlementsFile": {
"type": "string",
"format": "binary",
"description": "Entitlements file (.entitlements)"
}
}
}
}
}
}
},
"delete": {
"operationId": "CredentialsController_deleteOsx",
"responses": {
"204": {
"description": "No Content"
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Delete specific OSX credentials for a project. NOTE: you must be a manager in the project's organization to delete credentials.",
"summary": "Delete OSX Credentials",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/credentials/signing/osx/{credentialid}": {
"get": {
"operationId": "CredentialsController_getOneOsxForOrg",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddCredentialsOsxForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get specific OSX credential details",
"summary": "Get OSX Credential Details for organization",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"put": {
"operationId": "CredentialsController_updateOsxForOrg",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddCredentialsOsxForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Update an OSX certificate / provisioning profile. NOTE: you must be a manager in the project's organization to update credentials.",
"summary": "Update OSX Credentials for organization",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": false,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label for the updated credentials"
},
"appleIdUsername": {
"type": "string",
"description": "Apple ID Username"
},
"appleIdPassword": {
"type": "string",
"description": "Apple ID Password"
},
"certificatePass": {
"type": "string",
"description": "Certificate (.p12) password"
},
"providerName": {
"type": "string",
"description": "Provider Name"
},
"certificate": {
"type": "string",
"format": "binary",
"description": "Certificate file (.p12)"
},
"entitlementsFile": {
"type": "string",
"format": "binary",
"description": "Entitlements file (.entitlements)"
}
}
}
}
}
}
},
"delete": {
"operationId": "CredentialsController_deleteOsxForOrg",
"responses": {
"204": {
"description": "No Content"
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Delete specific OSX credentials. NOTE: you must be a manager in the project's organization to delete credentials.",
"summary": "Delete OSX Credentials for organization",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/credentials/signing/uwp/{credentialid}": {
"get": {
"operationId": "CredentialsController_getOneUwp",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddCredentialsUwpForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get specific UWP credential details",
"summary": "Get UWP Credential Details",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"put": {
"operationId": "CredentialsController_updateUwp",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddCredentialsUwpForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Update an UWP certificate / provisioning profile for the project. NOTE: you must be a manager in the project's organization to update credentials.",
"summary": "Update UWP Credentials",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": false,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label for the updated credentials"
},
"certificatePass": {
"type": "string",
"description": "Certificate (.p12) password"
},
"certificate": {
"type": "string",
"format": "binary",
"description": "Certificate file (.p12)"
}
}
}
}
}
}
},
"delete": {
"operationId": "CredentialsController_deleteUwp",
"responses": {
"204": {
"description": "No Content"
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Delete specific UWP credentials for a project. NOTE: you must be a manager in the project's organization to delete credentials.",
"summary": "Delete UWP Credentials",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/credentials/signing/uwp/{credentialid}": {
"get": {
"operationId": "CredentialsController_getOneUwpForOrg",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddCredentialsUwpForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get specific UWP credential details",
"summary": "Get UWP Credential Details for organization",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"put": {
"operationId": "CredentialsController_updateUwpForOrg",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddCredentialsUwpForOrgResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Update an UWP certificate / provisioning profile. NOTE: you must be a manager in the project's organization to update credentials.",
"summary": "Update UWP Credentials for organization",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": false,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label for the updated credentials"
},
"certificatePass": {
"type": "string",
"description": "Certificate (.p12) password"
},
"certificate": {
"type": "string",
"format": "binary",
"description": "Certificate file (.p12)"
}
}
}
}
}
}
},
"delete": {
"operationId": "CredentialsController_deleteUwpForOrg",
"responses": {
"204": {
"description": "No Content"
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Delete specific UWP credentials. NOTE: you must be a manager in the project's organization to delete credentials.",
"summary": "Delete UWP Credentials for organization",
"tags": [
"Credentials"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "credentialid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/changelogs": {
"get": {
"operationId": "ChangelogsController_getChangelogs",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ChangelogItem"
},
"type": "array"
}
}
},
"headers": {
"Content-Range": {
"schema": {
"type": "string"
},
"required": true
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get Unity Build Automation changelogs",
"summary": "Retrieves all changelog lines with page-based pagination",
"tags": [
"Public"
],
"parameters": [
{
"description": "The maximum number of items to return in a single request",
"in": "query",
"name": "per_page",
"required": false,
"schema": {
"default": 25,
"format": "int64",
"type": "integer",
"minimum": 1
},
"example": 25
},
{
"description": "The page number to return",
"in": "query",
"name": "page",
"required": false,
"schema": {
"default": 1,
"format": "int64",
"type": "integer",
"minimum": 1
},
"example": 1
},
{
"description": "Filter by specific changelog type (e.g., 'unity', 'xcode')",
"in": "query",
"name": "logType",
"required": false,
"schema": {
"type": "string"
},
"example": "unity"
},
{
"description": "Search term to filter changelog messages",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
},
"example": "2022.3"
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/versions/cache_compression_levels": {
"get": {
"operationId": "CacheCompressionLevelsController_listCacheCompressionLevels",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/CacheCompressionListResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "List cache compression levels for projects and build targets",
"summary": "List cache compression levels for projects and build targets",
"tags": [
"CacheCompressionLevels"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/buildtargets": {
"get": {
"operationId": "BuildTargetsController_getBuildTargets",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/AddBuildTargetResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Gets all configured build targets for a project, regardless of whether they are enabled. Settings and credentials are always included.",
"summary": "List all build targets for a project",
"tags": [
"BuildTargets"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"format": "int64",
"type": "integer",
"minimum": 1
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"format": "int64",
"type": "integer",
"minimum": 0
}
},
{
"in": "query",
"name": "lastBuiltUnityVersion",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "operatingSystem",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "sortby",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"example": [
"name",
"-created"
]
},
{
"in": "query",
"name": "platform",
"required": false,
"schema": {
"$ref": "#/components/schemas/Platform"
}
},
{
"in": "query",
"name": "branch",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "xcodeVersion",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "androidVersion",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "unityVersion",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "osVersion",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "buildTargetName",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "createdBy",
"required": false,
"schema": {
"$ref": "#/components/schemas/CreatedByOption"
}
},
{
"in": "query",
"name": "groupName",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "include_last_success",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "filterForCacheCopy",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter to only scene-preview (true) or non-scene-preview (false) build targets.",
"in": "query",
"name": "scenePreview",
"required": false,
"schema": {
"type": "boolean"
}
}
]
},
"post": {
"operationId": "BuildTargetsController_addBuildTarget",
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddBuildTargetResponse"
}
}
}
},
"422": {
"description": "Unprocessable Entity - one or more settings are no longer supported; each `details` key names the stored setting, not the request field",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Create build target for a project",
"summary": "Create build target for a project",
"tags": [
"BuildTargets"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddBuildTargetRequestBody"
}
}
}
}
}
},
"/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}": {
"get": {
"operationId": "BuildTargetsController_getBuildTarget",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddBuildTargetResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get a build target",
"summary": "Get a build target",
"tags": [
"BuildTargets"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"put": {
"operationId": "BuildTargetsController_updateBuildTarget",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddBuildTargetResponse"
}
}
}
},
"422": {
"description": "Unprocessable Entity - one or more settings are no longer supported; each `details` key names the stored setting, not the request field",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Update build target details",
"summary": "Update build target details",
"tags": [
"BuildTargets"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddBuildTargetRequestBody"
}
}
}
}
},
"delete": {
"operationId": "BuildTargetsController_deleteBuildTarget",
"responses": {
"204": {
"description": "No Content"
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Delete build target",
"summary": "Delete build target",
"tags": [
"BuildTargets"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/auditlog": {
"get": {
"operationId": "BuildTargetsController_getAuditLogForBuildTarget",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/AuditLogResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Retrieve a list of historical settings changes for this build target.",
"summary": "Get audit log",
"tags": [
"BuildTargets"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The maximum number of items to return in a single request",
"in": "query",
"name": "per_page",
"required": false,
"schema": {
"default": 25,
"format": "int64",
"type": "integer",
"minimum": 1
},
"example": 25
},
{
"description": "The page number to return",
"in": "query",
"name": "page",
"required": false,
"schema": {
"default": 1,
"format": "int64",
"type": "integer",
"minimum": 1
},
"example": 1
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/compatibletargets": {
"get": {
"operationId": "BuildTargetsController_getCompatibleTargetsFromBuildTarget",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/AddBuildTargetResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Retrieve a list of build targets that are able to share caches with the specified build target.",
"summary": "Get all build targets that can share caches with the specified build target",
"tags": [
"BuildTargets"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/stats": {
"get": {
"operationId": "BuildTargetsController_getStatsForBuildTarget",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetStatsForBuildTargetResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get statistics for the specified build target",
"summary": "Get build target statistics",
"tags": [
"BuildTargets"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "buildStatus",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "cleanBuild",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"format": "int64",
"type": "integer",
"minimum": 1
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds": {
"get": {
"operationId": "BuildAttemptsController_getBuilds",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/GetBuildResponse"
},
"type": "array"
}
}
},
"headers": {
"Content-Range": {
"schema": {
"type": "string"
},
"required": true
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "List all running and finished builds, sorted by build number (optionally paginating the results). Use '_all' as the buildtargetid to get all configured build targets. The response includes a Content-Range header that identifies the range of results returned and the total number of results matching the given query parameters.",
"summary": "List all builds",
"tags": [
"BuildAttempts"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The maximum number of items to return in a single request",
"in": "query",
"name": "per_page",
"required": false,
"schema": {
"default": 25,
"format": "int64",
"type": "integer",
"minimum": 1
},
"example": 25
},
{
"description": "The page number to return",
"in": "query",
"name": "page",
"required": false,
"schema": {
"default": 1,
"format": "int64",
"type": "integer",
"minimum": 1
},
"example": 1
},
{
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "buildStatus",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "platform",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "showDeleted",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "onlyFavorites",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "onlyReferenceBuildAttempt",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "eligibleReferenceBuildAttempts",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "eligibleLatestPatchBuildAttempts",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "onlyMyBuilds",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "onlyEditorBuilds",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "cleanBuild",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Only include builds whose artifacts are currently available (uploaded and not deleted). Combine with hasNoArtifacts to request both; omitting both applies no artifact filter.",
"in": "query",
"name": "hasArtifacts",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Only include builds without available artifacts (never uploaded, or already deleted). Combine with hasArtifacts to request both; omitting both applies no artifact filter.",
"in": "query",
"name": "hasNoArtifacts",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "failureLabel",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "internalUrls",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter to only scene-preview (true) or non-scene-preview (false) builds.",
"in": "query",
"name": "scenePreview",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "buildProfile",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "onlyLatestPatchBuildAttempt",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "latestBuildPerPlatformOnly",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "targetGroup",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "groupBuildId",
"required": false,
"schema": {
"type": "string"
}
}
]
},
"post": {
"operationId": "BuildTargetsController_startBuilds",
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/GetBuildResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Start the build process for this build target (or all targets, if '_all' is specified as the buildtargetid), if there is not one currently in process. A refused start answers 409 when the target already has a build pending, and 422 for any other reason. When '_all' is specified and only some of the targets are refused, the response is still 202 and each refusal is reported in the 'error' field of its own entry.",
"summary": "Create new build",
"tags": [
"BuildTargets"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StartBuildsRequestBody"
}
}
}
}
},
"delete": {
"operationId": "BuildTargetsController_cancelAllBuilds",
"responses": {
"204": {
"description": "No Content"
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Cancel all builds in progress for this build target (or all targets, if '_all' is specified as the buildtargetid). Canceling an already finished build will do nothing and respond successfully.",
"summary": "Cancel all builds",
"tags": [
"BuildTargets"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/buildTargetGroups": {
"get": {
"operationId": "BuildTargetGroupsController_getBuildTargetGroups",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetBuildTargetGroupsResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "List all build target groups for a project",
"summary": "List all build target groups for a project",
"tags": [
"BuildTargetGroups"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"post": {
"operationId": "BuildTargetGroupsController_createBuildTargetGroup",
"responses": {
"201": {
"description": "CREATED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateBuildTargetGroupResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Create build target group for a project",
"summary": "Create build target group for a project",
"tags": [
"BuildTargetGroups"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateBuildTargetGroupRequestBody"
}
}
}
}
},
"delete": {
"operationId": "BuildTargetGroupsController_deleteBuildTargetGroups",
"responses": {
"204": {
"description": "No Content",
"content": {
"application/json": {
"schema": {
"type": "string"
},
"examples": {
"Example 1": {
"value": "Build target groups deleted successfully"
}
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Delete build target groups for a project",
"summary": "Delete build target groups for a project",
"tags": [
"BuildTargetGroups"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteBuildTargetGroupsRequestBody"
}
}
}
}
}
},
"/orgs/{orgid}/projects/{projectid}/buildTargetGroups/{buildtargetgroupid}": {
"patch": {
"operationId": "BuildTargetGroupsController_updateBuildTargetGroup",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateBuildTargetGroupResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Update build target group for a project",
"summary": "Update build target group for a project",
"tags": [
"BuildTargetGroups"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetgroupid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateBuildTargetGroupRequestBody"
}
}
}
}
}
},
"/orgs/{orgid}/projects/{projectid}/buildTargetGroups/{buildtargetgroupid}/enabled": {
"put": {
"operationId": "BuildTargetGroupsController_updateBuildTargetGroupEnabled",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateBuildTargetGroupResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Set enabled state of build target group for a project",
"summary": "Set enabled state of build target group for a project",
"tags": [
"BuildTargetGroups"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetgroupid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateBuildTargetGroupEnabledRequestBody"
}
}
}
}
}
},
"/orgs/{orgid}/projects/{projectid}/buildTargetGroups/enabled": {
"put": {
"operationId": "BuildTargetGroupsController_updateBuildTargetGroupsEnabled",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetBuildTargetGroupsResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Set enabled state of build target groups for a project",
"summary": "Set enabled state of build target groups for a project",
"tags": [
"BuildTargetGroups"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateBuildTargetGroupsEnabledRequestBody"
}
}
}
}
}
},
"/orgs/{orgid}/projects/{projectid}/builds/cancel": {
"post": {
"operationId": "BuildAttemptsController_batchCancelBuilds",
"responses": {
"204": {
"description": "No Content"
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Cancel all builds whose build target ids and build numbers are included in the builds array. Builds that are not currently in progress will be ignored",
"summary": "Cancel artifacts for a batch of builds",
"tags": [
"BuildAttempts"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchCancelBuildsRequestBody"
}
}
}
}
}
},
"/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}": {
"get": {
"operationId": "BuildAttemptsController_getBuild",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetBuildResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Retrieve information for a specific build. A Build resource contains information related to a build attempt for a build target, including the build number, changeset, build times, and other pertinent data.",
"summary": "Get build Status",
"tags": [
"BuildAttempts"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "number",
"required": true,
"schema": {
"$ref": "#/components/schemas/BuildNumber"
}
},
{
"description": "Optional properties to return: `testResults`. Omit this parameter to receive it; supply it without naming `testResults` to leave it out. Values it does not recognise are ignored. `failureDetails`, `buildReports` and `links.artifacts` are also accepted and add to the response.",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "showHidden",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "internalUrls",
"required": false,
"schema": {
"type": "boolean"
}
}
]
},
"put": {
"operationId": "BuildAttemptsController_updateBuild",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetBuildResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Update build information",
"summary": "Update build information",
"tags": [
"BuildAttempts"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "number",
"required": true,
"schema": {
"$ref": "#/components/schemas/BuildNumber"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateBuildRequestBody"
}
}
}
}
},
"delete": {
"operationId": "BuildAttemptsController_cancelBuild",
"responses": {
"204": {
"description": "No Content"
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Cancel a build in progress. Canceling an already finished build will do nothing and respond successfully.",
"summary": "Cancel build",
"tags": [
"BuildAttempts"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "number",
"required": true,
"schema": {
"$ref": "#/components/schemas/BuildNumber"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}/share": {
"get": {
"operationId": "BuildAttemptsController_getShare",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetShareResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Gets a share link if it exists",
"summary": "Get the share link",
"tags": [
"BuildAttempts"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "number",
"required": true,
"schema": {
"$ref": "#/components/schemas/BuildNumber"
}
}
]
},
"post": {
"operationId": "BuildAttemptsController_createShare",
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetShareResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Create a new short link to share a project. If this is called when a share already exists, that share will be revoked and a new one created.",
"summary": "Create a new link to share a project",
"tags": [
"BuildAttempts"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "number",
"required": true,
"schema": {
"$ref": "#/components/schemas/BuildNumber"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateShareRequestBody"
}
}
}
}
},
"put": {
"operationId": "BuildAttemptsController_modifyShare",
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetShareResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Modify an existing share link. Only intended for updating the Expiry without revoking the link.",
"summary": "Modify existing share link",
"tags": [
"BuildAttempts"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "number",
"required": true,
"schema": {
"$ref": "#/components/schemas/BuildNumber"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateShareRequestBody"
}
}
}
}
},
"delete": {
"operationId": "BuildAttemptsController_revokeShare",
"responses": {
"204": {
"description": "No Content"
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Revoke a shared link, both {buildtargetid} and {number} may use _all to revoke all share links for a given buildtarget or entire project.",
"summary": "Revoke a shared link",
"tags": [
"BuildAttempts"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "number",
"required": true,
"schema": {
"$ref": "#/components/schemas/BuildNumber"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}/filetoken/{token}": {
"get": {
"operationId": "BuildAttemptsController_getBuildWithFiletoken",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetBuildResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Retrieve information for a specific build using a time-limited filetoken. This endpoint provides an alternative to JWT authentication, allowing builds to be accessed with a temporary token that expires after 30 minutes.",
"summary": "Get build Status (with filetoken)",
"tags": [
"BuildAttempts"
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "number",
"required": true,
"schema": {
"$ref": "#/components/schemas/BuildNumber"
}
},
{
"in": "path",
"name": "token",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Optional properties to return: `testResults`. Omit this parameter to receive it; supply it without naming `testResults` to leave it out. Values it does not recognise are ignored. `failureDetails`, `buildReports` and `links.artifacts` are also accepted and add to the response.",
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "showHidden",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "internalUrls",
"required": false,
"schema": {
"type": "boolean"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}/log": {
"get": {
"operationId": "BuildAttemptsController_getBuildLog",
"responses": {
"200": {
"description": "OK - Returns log content directly",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"202": {
"description": "Accepted - Returns payload containing the signed URL (redirect=manual)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetBuildLogResponse"
}
}
}
},
"307": {
"description": "Temporary Redirect - Automatically redirects to signed URL"
},
"404": {
"description": "Not Found - No log is available for this build",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Retrieve the plain text log for a specific build. Please note that this route will normally redirect with a 303 code to the build log for a completed job, so it is important to follow redirects.",
"summary": "Get build log for a build attempt",
"tags": [
"BuildAttempts"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "number",
"required": true,
"schema": {
"$ref": "#/components/schemas/BuildNumber"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"format": "int64",
"type": "integer"
}
},
{
"in": "query",
"name": "offsetlines",
"required": false,
"schema": {
"format": "int64",
"type": "integer",
"minimum": 0
}
},
{
"in": "query",
"name": "linenumbers",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "lastLineNumber",
"required": false,
"schema": {
"format": "int64",
"type": "integer",
"minimum": 0
}
},
{
"in": "query",
"name": "compact",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "withHtml",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "progressive",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "maxLines",
"required": false,
"schema": {
"format": "int64",
"type": "integer",
"minimum": 1
}
},
{
"in": "query",
"name": "redirect",
"required": false,
"schema": {
"$ref": "#/components/schemas/BuildLogRedirectType"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}/download/{filename}": {
"get": {
"operationId": "BuildAttemptsController_getFileDownloadUrl",
"responses": {
"303": {
"description": "See Other",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetFileDownloadUrlResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Retrieve the download link for a specified build artifact.\n\nAlthough this endpoint returns a `303 See Other` status, it does **not** behave like a standard HTTP redirect: the signed storage URL is returned in the response body (see `GetFileDownloadUrlResponse`) and no `Location` header is set. Clients that auto-follow redirects (e.g. `curl -L`, browser fetch with default settings) will *not* follow it. To download the artifact, parse the URL from the body and issue a follow-up `GET` against it.",
"summary": "Get build artifact download link",
"tags": [
"BuildAttempts"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "number",
"required": true,
"schema": {
"$ref": "#/components/schemas/BuildNumber"
}
},
{
"in": "path",
"name": "filename",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}/download/{filename}/filetoken/{token}": {
"get": {
"operationId": "BuildAttemptsController_getFileDownloadUrlWithFiletoken",
"responses": {
"303": {
"description": "See Other",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetFileDownloadUrlResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Retrieve the download link for a specified build artifact using a time-limited filetoken. This endpoint provides an alternative to JWT authentication.\n\nReturns a `303 See Other` with the signed storage URL in the response body — see `getFileDownloadUrl` for the same caveat about no `Location` header being set.",
"summary": "Get build artifact download link (with filetoken)",
"tags": [
"BuildAttempts"
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "number",
"required": true,
"schema": {
"$ref": "#/components/schemas/BuildNumber"
}
},
{
"in": "path",
"name": "filename",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "token",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/builds": {
"get": {
"operationId": "BuildAttemptsController_getBuildsForOrg",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/GetBuildResponse"
},
"type": "array"
}
}
},
"headers": {
"Content-Range": {
"schema": {
"type": "string"
},
"required": true
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "List all running and finished builds, sorted by build number (optionally paginating the results). The response includes a Content-Range header that identifies the range of results returned and the total number of results matching the given query parameters.",
"summary": "List all builds for org",
"tags": [
"BuildAttempts"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The maximum number of items to return in a single request",
"in": "query",
"name": "per_page",
"required": false,
"schema": {
"default": 25,
"format": "int64",
"type": "integer",
"minimum": 1
},
"example": 25
},
{
"description": "The page number to return",
"in": "query",
"name": "page",
"required": false,
"schema": {
"default": 1,
"format": "int64",
"type": "integer",
"minimum": 1
},
"example": 1
},
{
"in": "query",
"name": "include",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "buildStatus",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "platform",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "showDeleted",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "onlyFavorites",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "onlyReferenceBuildAttempt",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "eligibleReferenceBuildAttempts",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "eligibleLatestPatchBuildAttempts",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "onlyMyBuilds",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "onlyEditorBuilds",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "cleanBuild",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Only include builds whose artifacts are currently available (uploaded and not deleted). Combine with hasNoArtifacts to request both; omitting both applies no artifact filter.",
"in": "query",
"name": "hasArtifacts",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Only include builds without available artifacts (never uploaded, or already deleted). Combine with hasArtifacts to request both; omitting both applies no artifact filter.",
"in": "query",
"name": "hasNoArtifacts",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "failureLabel",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "internalUrls",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter to only scene-preview (true) or non-scene-preview (false) builds.",
"in": "query",
"name": "scenePreview",
"required": false,
"schema": {
"type": "boolean"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}/steps": {
"get": {
"operationId": "BuildAttemptsController_getBuildSteps",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/BuildStepResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Retrieves all build steps for a build, this replaces the old method where we would manually download the build report artifacts and allows us to add more functionality into build steps.",
"summary": "Get the build steps for a given build",
"tags": [
"BuildAttempts"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "number",
"required": true,
"schema": {
"$ref": "#/components/schemas/BuildNumber"
}
},
{
"in": "query",
"name": "showHidden",
"required": false,
"schema": {
"type": "boolean"
}
}
]
}
},
"/shares/{shareid}": {
"get": {
"operationId": "BuildAttemptsController_getShareMetadata",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetBuildResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "This is an endpoint accessible without an api key that provides information about a specific build including download links. A shareid is generated by POSTing to a build's share endpoint.",
"summary": "Get details on shared build including download link",
"tags": [
"BuildAttempts"
],
"parameters": [
{
"in": "path",
"name": "shareid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}/resign": {
"post": {
"operationId": "BuildAttemptsController_resignBuildArtifact",
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/GetBuildResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Re-sign a build artifact using the most recent credentials associated with the buildtarget.\n\nA refused resign answers 409 when the build target already has a build pending, and 422 for any other reason.",
"summary": "Re-sign a build artifact",
"tags": [
"BuildAttempts"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "number",
"required": true,
"schema": {
"$ref": "#/components/schemas/BuildNumber"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}/artifacts": {
"get": {
"operationId": "ArtifactsController_listArtifacts",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ArtifactResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Retrieve a list of all artifacts associated with a specific build, including download links for each artifact file.",
"summary": "List all artifacts for a build",
"tags": [
"BuildAttempts"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "number",
"required": true,
"schema": {}
}
]
},
"post": {
"operationId": "ArtifactsController_createArtifact",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtifactResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Create a new artifact for a build. This registers the artifact metadata before files can be uploaded using the TUS protocol endpoints.",
"summary": "Create a new artifact",
"tags": [
"BuildAttempts"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "number",
"required": true,
"schema": {}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateArtifactRequestBody"
}
}
}
}
},
"delete": {
"operationId": "ArtifactsController_deleteBuildArtifacts",
"responses": {
"204": {
"description": "No Content"
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Delete all artifacts associated with a specific build",
"summary": "Delete all artifacts associated with a specific build",
"tags": [
"BuildAttempts"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "number",
"required": true,
"schema": {}
},
{
"in": "query",
"name": "retainLogs",
"required": false,
"schema": {
"type": "boolean"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}/artifacts/{artifactname}/upload/{filename}": {
"post": {
"operationId": "ArtifactsController_startArtifactFileUpload",
"responses": {
"201": {
"description": "Upload session created"
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Initialize a new file upload for an artifact using the TUS resumable upload protocol. This creates the upload session and prepares for receiving file chunks via PATCH.",
"summary": "Start artifact file upload (TUS protocol)",
"tags": [
"BuildAttempts"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "number",
"required": true,
"schema": {}
},
{
"in": "path",
"name": "artifactname",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "filename",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "Tus-Resumable",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "Upload-Length",
"required": true,
"schema": {
"format": "double",
"type": "number"
}
}
]
},
"patch": {
"operationId": "ArtifactsController_uploadArtifactFileChunk",
"responses": {
"204": {
"description": "Chunk uploaded successfully"
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Upload a chunk of an artifact file using the TUS resumable upload protocol. The Upload-Offset header specifies where this chunk should be written.",
"summary": "Upload artifact file chunk (TUS protocol)",
"tags": [
"BuildAttempts"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "number",
"required": true,
"schema": {}
},
{
"in": "path",
"name": "artifactname",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "filename",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "Tus-Resumable",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "Upload-Offset",
"required": true,
"schema": {
"format": "double",
"type": "number"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/offset+octet-stream": {
"schema": {
"$ref": "#/components/schemas/TusResumableBinary"
}
}
}
}
},
"head": {
"operationId": "ArtifactsController_checkArtifactFileUploadStatus",
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "Artifact file not found"
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Check the current upload status of an artifact file using the TUS resumable upload protocol. Returns Upload-Offset and Upload-Length headers indicating the current upload progress.",
"summary": "Check artifact file upload status (TUS protocol)",
"tags": [
"BuildAttempts"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "number",
"required": true,
"schema": {}
},
{
"in": "path",
"name": "artifactname",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "filename",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "Tus-Resumable",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/artifacts/delete": {
"post": {
"operationId": "ArtifactsController_batchDeleteBuildArtifacts",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchDeleteBuildArtifactsResponse"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Delete all artifacts whose build target ids and build numbers are included in the builds array. Alternatively, delete all builds that match a given filter, excluding builds from the operation by including their build target ids and build numbers in the excludedBuilds array (the allWithExclusions query parameter must be set to true for this to work). Builds that are favorited, or whose status does not match one of the following statuses, will not be deleted: success, failure, canceled, unknown.",
"summary": "Delete artifacts for a batch of builds",
"tags": [
"BuildAttempts"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "allWithExclusions",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "retainLogs",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchDeleteBuildArtifactsRequestBody"
}
}
}
}
}
},
"/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/artifacts": {
"delete": {
"operationId": "ArtifactsController_deleteAllBuildArtifacts",
"responses": {
"204": {
"description": "No Content"
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Delete all artifacts associated with all non-favorited builds for a specified build target. The build target ID '_all' is allowed to delete artifacts across all build targets.",
"summary": "Delete all artifacts for a build target",
"tags": [
"BuildAttempts"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}/artifacts/complete": {
"post": {
"operationId": "ArtifactsController_completeDirectUpload",
"responses": {
"200": {
"description": "Upload completed successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompleteDirectUploadResponse"
}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "File not found"
},
"409": {
"description": "Conflict"
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Complete a direct upload that was done via signed URLs (bypassing TUS). This endpoint creates the artifact record and triggers post-processing. Used when files are uploaded directly to GCS using signed URLs.",
"summary": "Complete a direct upload (bypassing TUS)",
"tags": [
"BuildAttempts"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "buildtargetid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "number",
"required": true,
"schema": {}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompleteDirectUploadRequestBody"
}
}
}
}
}
},
"/orgs/{orgid}/projects/{projectid}/android_sdk_config/{unityVersionValue}": {
"get": {
"operationId": "AndroidSdkController_getAndroidSdk",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/AndroidSdkResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "Get an Android SDK for a Unity Version",
"summary": "Get an Android SDK for a Unity Version",
"tags": [
"AndroidSdk"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "unityVersionValue",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/orgs/{orgid}/projects/{projectid}/android_sdk_config": {
"get": {
"operationId": "AndroidSdkController_listAndroidSdkConfig",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/AndroidSdkConfigResponse"
},
"type": "array"
}
}
}
},
"4XX": {
"description": "Client Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
},
"5XX": {
"description": "Server Side Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RFC7807Error"
}
}
}
}
},
"description": "List Android SDK Config",
"summary": "List Android SDK Config",
"tags": [
"AndroidSdk"
],
"security": [
{
"basicAuth": []
},
{
"jwt": []
}
],
"parameters": [
{
"in": "path",
"name": "orgid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectid",
"required": true,
"schema": {
"type": "string"
}
}
]
}
}
},
"servers": [
{
"url": "https://build-automation.services.api.unity.com/v2"
}
],
"tags": [
{
"name": "AndroidSdk",
"description": "Endpoints for querying Android SDK configuration."
},
{
"name": "BuildAttempts",
"description": "Endpoints for managing and querying build attempts."
},
{
"name": "BuildTargetGroups",
"description": "Endpoints for managing and querying build target groups."
},
{
"name": "BuildTargets",
"description": "Endpoints for managing and querying build targets."
},
{
"name": "CacheCompressionLevels",
"description": "Endpoints for querying cache compression levels."
},
{
"name": "Credentials",
"description": "Endpoints for managing signing credentials for build targets."
},
{
"name": "Device",
"description": "Endpoints for managing device information."
},
{
"name": "Editor",
"description": "Endpoints for editor configuration and settings."
},
{
"name": "EnvVars",
"description": "Endpoints for managing environment variables for builds."
},
{
"name": "Failures",
"description": "Endpoints for managing and querying build failure information and feedback."
},
{
"name": "MachineTypes",
"description": "Endpoints for querying available machine types."
},
{
"name": "OAuth",
"description": "Endpoints for OAuth authentication."
},
{
"name": "OperatingSystemVersions",
"description": "Endpoints for querying available operating system versions."
},
{
"name": "Orgs",
"description": "Endpoints for managing and querying organization information."
},
{
"name": "Plastic",
"description": "Endpoints for Plastic SCM integration."
},
{
"name": "PlatformRequirements",
"description": "Endpoints for querying platform requirements."
},
{
"name": "Platforms",
"description": "Endpoints for querying supported build platforms."
},
{
"name": "Project",
"description": "Endpoints for managing and querying project information."
},
{
"name": "ProjectPreview",
"description": "Endpoints for querying Project Preview build state."
},
{
"name": "ScenePreview",
"description": "Endpoints for querying scene-preview build targets and their build state."
},
{
"name": "Public",
"description": "Public endpoints that do not require authentication and are available to all users."
},
{
"name": "RetentionPolicy",
"description": "Endpoints for managing and querying retention policies for projects."
},
{
"name": "SCM",
"description": "Endpoints for source control management integration."
},
{
"name": "Admin",
"description": "Admin endpoints for managing resources."
},
{
"name": "Status",
"description": "Endpoints for checking service status."
},
{
"name": "UnityVersions",
"description": "Endpoints for querying available Unity versions."
},
{
"name": "Users",
"description": "Endpoints for managing users."
},
{
"name": "VisualStudioVersions",
"description": "Endpoints for querying available Visual Studio versions."
},
{
"name": "XcodeVersions",
"description": "Endpoints for querying available Xcode versions."
}
],
"info": {
"version": "2.0.0",
"title": "Unity Build Automation",
"description": "This REST API is intended to be used in conjunction with [Unity Build Automation](https://docs.unity.com/en-us/build-automation).\n\n## Authentication\n\nAuthenticate with HTTP Basic auth using a Unity **service account** key and secret (`Authorization: Basic `). The legacy Build Automation API key is not supported on v2.\n\nFor a step-by-step guide, see [Migrating your UBA REST API calls from V1 to V2](https://support.unity.com/hc/en-us/articles/51178448254356-How-do-I-migrate-my-Unity-Build-Automation-UBA-REST-API-calls-from-V1-to-V2) and [Create a service account](https://docs.unity.com/en-us/cloud/accounts/create-service-account).\n\n> **Note:** This documentation describes **version 2** of the Unity Build Automation API. Version 2 is current and supported, and it holds most of the API. Version 3 covers only projects and their source-control connections, and the version 2 endpoints it replaces are marked deprecated. For the previous version, refer to the [v1 reference documentation](https://build-api.cloud.unity3d.com/docs/).",
"contact": {
"name": "Unity Build Automation team",
"url": "https://unity.com/solutions/ci-cd",
"email": "cloudbuild@unity3d.com"
},
"license": {
"name": "Unity Legal",
"url": "https://unity.com/legal"
}
},
"components": {
"schemas": {
"StatusCodes": {
"enum": [
100,
101,
102,
103,
200,
201,
202,
203,
204,
205,
206,
207,
300,
301,
302,
303,
304,
305,
307,
308,
400,
401,
402,
403,
404,
405,
406,
407,
408,
409,
410,
411,
412,
413,
414,
415,
416,
417,
418,
419,
420,
421,
422,
423,
424,
426,
428,
429,
431,
451,
500,
501,
502,
503,
504,
505,
507,
511
],
"type": "number"
},
"GatewayCodes": {
"description": "API Error Codes that are used by the Unity Gateway for showing helper links to users in the Error API Response.",
"enum": [
2,
51,
53,
54,
55,
57,
58,
59,
61,
62
],
"type": "number"
},
"RFC7807ErrorJSON": {
"properties": {
"requestId": {
"type": "string",
"description": "Unique identifier for this request"
},
"details": {
"items": {
"properties": {},
"additionalProperties": {},
"type": "object"
},
"type": "array",
"description": "Additional details about the error that may be at a more granular level"
},
"detail": {
"type": "string",
"description": "Description of the error"
},
"type": {
"type": "string",
"description": "Link to documentation about the specific error so that the caller can understand what went wrong"
},
"code": {
"$ref": "#/components/schemas/GatewayCodes"
},
"title": {
"type": "string",
"description": "HTTP status text, for example, Forbidden, or a top level description of the error type"
},
"status": {
"$ref": "#/components/schemas/StatusCodes"
}
},
"required": [
"requestId",
"details",
"detail",
"type",
"code",
"title",
"status"
],
"type": "object",
"description": "Error response is in the RFC7807-format."
},
"RFC7807Error": {
"$ref": "#/components/schemas/RFC7807ErrorJSON"
},
"XcodeVersion": {
"description": "Xcode version configuration",
"properties": {
"hidden": {
"type": "boolean",
"example": true
},
"deprecated": {
"type": "boolean",
"example": true
},
"name": {
"type": "string",
"example": "John Doe"
},
"value": {
"type": "string",
"example": "example-value"
}
},
"type": "object",
"additionalProperties": false
},
"VisualStudioVersionResponse": {
"description": "Visual Studio version response",
"properties": {
"visual_studio_version": {
"type": "string",
"example": "2024"
},
"windows_sdk_versions": {
"items": {
"type": "string"
},
"type": "array",
"example": [
"10.0.17134.0",
"10.0.17763.0",
"10.0.18362.0"
]
}
},
"required": [
"visual_studio_version",
"windows_sdk_versions"
],
"type": "object",
"additionalProperties": false
},
"UserOrg": {
"description": "Organization information associated with a user",
"properties": {
"name": {
"type": "string",
"nullable": true,
"description": "Organization name"
},
"id": {
"type": "string",
"nullable": true,
"description": "Unity Organization ID"
},
"foreign_key": {
"type": "string",
"nullable": true,
"description": "Unity Organization ID"
}
},
"type": "object",
"additionalProperties": false
},
"HttpMethod": {
"type": "string",
"enum": [
"options",
"get",
"post",
"put",
"patch",
"delete",
"head"
],
"default": "get",
"description": "HTTP method type"
},
"Record_string.unknown_": {
"properties": {},
"additionalProperties": {},
"type": "object",
"description": "Construct a type with a set of properties K of type T"
},
"Link": {
"description": "A hypermedia link describing a related API action or resource.\n\nThis is a generic link object produced by `addResourceLink` (buildservice & userservice) and credential `projects[]` transforms.",
"properties": {
"method": {
"$ref": "#/components/schemas/HttpMethod"
},
"href": {
"type": "string",
"description": "URL for the related resource. May be either an absolute URL (e.g. a signed storage URL that can be requested directly) or a path relative to this API (which must be resolved against the host you used to make the original request).",
"example": "/some/path/to/resource"
},
"type": {
"type": "string",
"example": "application/json"
},
"meta": {
"$ref": "#/components/schemas/Record_string.unknown_"
},
"redirect": {
"type": "boolean",
"description": "When `true`, `href` points back at this API rather than directly at a storage backend.\n\nFollowing an internal `href` returns a `303 See Other` whose body is the signed storage URL as a JSON string. The response does **not** set a `Location` header, so standard redirect-following (e.g. `curl -L`, browser fetch with default settings, HTTP libraries with redirects enabled) will *not* follow it. To consume the link, clients must parse the URL from the body and `GET` it directly.",
"example": false
}
},
"required": [
"href"
],
"type": "object",
"additionalProperties": false
},
"Record_string.Link_": {
"properties": {},
"additionalProperties": {
"$ref": "#/components/schemas/Link"
},
"type": "object",
"description": "Construct a type with a set of properties K of type T"
},
"UserResponse": {
"description": "User response object containing user information and related data",
"properties": {
"email": {
"type": "string",
"nullable": true,
"description": "email address",
"example": "julie.smith@example.org"
},
"name": {
"type": "string",
"nullable": true,
"description": "full name",
"example": "Julie Smith"
},
"unityid": {
"type": "string",
"nullable": true,
"description": "internal unity id that is shared across services",
"example": "0000000"
},
"waiting": {
"type": "boolean",
"description": "when true the user is waiting to be approved for access to Build Automation",
"example": false
},
"permissions": {
"items": {
"type": "string",
"nullable": true
},
"type": "array"
},
"lastAcceptedEulaVersion": {
"type": "string",
"nullable": true
},
"disableNotifications": {
"type": "boolean",
"description": "when true build status email notifications will no longer be sent",
"example": false
},
"orgs": {
"items": {
"$ref": "#/components/schemas/UserOrg"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/Record_string.Link_"
}
},
"type": "object",
"additionalProperties": false
},
"UpdateUserRequest": {
"description": "Request body for updating user information",
"properties": {
"disableNotifications": {
"type": "boolean",
"description": "When true build status email notifications will no longer be sent",
"example": false
},
"lastAcceptedEulaVersion": {
"type": "string",
"description": "Last accepted EULA version",
"example": "1.0.0"
}
},
"type": "object",
"additionalProperties": false
},
"DeviceOperatingSystem": {
"type": "string",
"enum": [
"Android",
"iOS"
],
"description": "Device operating system (Android or iOS)"
},
"DeviceStatus": {
"type": "string",
"enum": [
"disabled",
"active"
],
"description": "Device status."
},
"UserDevice": {
"description": "User device model.",
"properties": {
"udid": {
"type": "string",
"description": "device unique identifier",
"example": "1234567890abcdef1234567890abcdef12345678",
"maxLength": 40,
"minLength": 40
},
"devicename": {
"type": "string",
"description": "device name",
"example": "iPhone 12"
},
"os": {
"$ref": "#/components/schemas/DeviceOperatingSystem"
},
"osversion": {
"type": "string",
"description": "operating system version",
"example": "14.0"
},
"product": {
"type": "string",
"description": "product",
"example": "iPhone"
},
"status": {
"$ref": "#/components/schemas/DeviceStatus"
}
},
"type": "object",
"additionalProperties": false
},
"CreateUserDevice": {
"description": "Request body for creating a new user device",
"properties": {
"udid": {
"type": "string",
"description": "device unique identifier",
"example": "1234567890abcdef1234567890abcdef12345678",
"maxLength": 40,
"minLength": 40
},
"devicename": {
"type": "string",
"description": "device name",
"example": "iPhone 12"
},
"os": {
"$ref": "#/components/schemas/DeviceOperatingSystem"
},
"osversion": {
"type": "string",
"description": "operating system version",
"example": "14.0"
},
"product": {
"type": "string",
"description": "product",
"example": "iPhone"
},
"status": {
"$ref": "#/components/schemas/DeviceStatus"
}
},
"type": "object",
"additionalProperties": false
},
"Platform": {
"type": "string",
"enum": [
"android",
"gamecorescarlett",
"ios",
"ps5",
"switch",
"standalonelinux",
"standalonelinux64",
"standalonelinuxuniversal",
"standaloneosxintel",
"standaloneosxintel64",
"standaloneosxuniversal",
"standaloneosx",
"standalonewindows",
"standalonewindows64",
"webgl",
"webplayer",
"wsaplayer"
],
"default": "webgl",
"description": "Unity build target platform"
},
"UnityArchitecture": {
"type": "string",
"enum": [
"AppleIntel",
"AppleSilicon"
],
"description": "Unity architecture (Apple Silicon or Apple Intel)"
},
"GetVersionResponse": {
"description": "Response for getVersion",
"properties": {
"name": {
"type": "string",
"example": "John Doe"
},
"value": {
"type": "string",
"example": "example-value"
},
"xcode_versions": {
"items": {
"type": "string"
},
"type": "array",
"example": [
"xcode13_2_1",
"xcode14_0"
]
},
"hidden": {
"type": "boolean",
"example": true
},
"deprecated": {
"type": "boolean",
"example": true
},
"cloudRenderingEnabled": {
"type": "boolean",
"example": true
},
"entitledPlatformsSupported": {
"items": {
"$ref": "#/components/schemas/Platform"
},
"type": "array",
"example": [
"ios",
"android",
"webgl"
]
},
"architectures": {
"items": {
"$ref": "#/components/schemas/UnityArchitecture"
},
"type": "array",
"example": [
"AppleIntel",
"AppleSilicon"
]
},
"isBuildProfileSupported": {
"type": "boolean",
"example": true
}
},
"type": "object",
"additionalProperties": false
},
"UnityVersionResponse": {
"description": "Unity version response",
"properties": {
"name": {
"type": "string",
"example": "Unity 2022.3.0f1"
},
"value": {
"type": "string",
"example": "2022.3.0f1"
},
"hidden": {
"type": "boolean",
"example": false
},
"deprecated": {
"type": "boolean",
"example": false
},
"cloudRenderingEnabled": {
"type": "boolean",
"example": true
},
"isBuildProfileSupported": {
"type": "boolean",
"example": true
},
"xcode_versions": {
"items": {
"type": "string"
},
"type": "array",
"example": [
"xcode14_0",
"xcode15_0"
]
},
"entitledPlatformsSupported": {
"items": {
"type": "string"
},
"type": "array",
"example": [
"ios",
"android"
]
},
"architectures": {
"items": {
"type": "string"
},
"type": "array",
"example": [
"arm64",
"x86_64"
]
}
},
"required": [
"name",
"value"
],
"type": "object",
"additionalProperties": false
},
"StatusResponse": {
"description": "Status message response",
"properties": {
"text": {
"type": "string",
"example": "This platform is not actively supported anymore and will be removed soon"
},
"platform": {
"type": "string",
"example": "webplayer"
},
"priority": {
"type": "integer",
"format": "int64",
"example": 1,
"minimum": 0
},
"billingPlan": {
"type": "string",
"example": "Personal"
},
"scmType": {
"type": "string",
"example": "git"
},
"alertType": {
"type": "string",
"example": "info"
},
"autoClear": {
"type": "boolean",
"example": false
},
"redirect": {
"type": "string",
"example": "https://example.com/redirect"
}
},
"required": [
"text"
],
"type": "object",
"additionalProperties": false
},
"UUID": {
"type": "string",
"format": "uuid",
"description": "Stringified UUIDv4, dashed or dashless: `buildGUID` is stored with the dashes stripped. Anchored because TSOA matches with an unanchored `RegExp.test`.",
"pattern": "^(?:[\\d\\w]{8}-[\\d\\w]{4}-[\\d\\w]{4}-[\\d\\w]{4}-[\\d\\w]{12}|[\\d\\w]{32})$"
},
"CapturedInfo": {
"description": "CapturedInfo object",
"properties": {
"fingerprint": {
"type": "string",
"example": "a1b2c3d4e5f6g7h8i9j0"
}
},
"type": "object",
"additionalProperties": false
},
"CheckUrlResponse": {
"description": "Response for checkUrl",
"properties": {
"isAccessible": {
"type": "boolean",
"example": true
},
"normalizedUrl": {
"type": "string",
"example": "https://github.com/unity/example-repo.git"
},
"errorMessages": {
"items": {
"type": "string"
},
"type": "array",
"example": [
"Invalid URL format",
"Repository not found"
]
},
"capturedInfo": {
"$ref": "#/components/schemas/CapturedInfo"
}
},
"type": "object",
"additionalProperties": false
},
"SupportedSCMType": {
"type": "string",
"enum": [
"git",
"svn",
"p4",
"oauth",
"plastic"
],
"description": "Source control management (SCM) system type. Values: 'git', 'svn', 'p4' (Perforce), 'oauth', or 'plastic' (UVCS)"
},
"SupportedAuthType": {
"type": "string",
"enum": [
"UPWorkingMode",
"LDAPWorkingMode",
"SSOWorkingMode",
"ticket",
"password"
],
"description": "Authentication type for Perforce or Plastic SCM. Perforce: 'ticket' or 'password' Plastic: 'UPWorkingMode', 'LDAPWorkingMode', or 'SSOWorkingMode'"
},
"SupportedPlasticEnvironment": {
"type": "string",
"enum": [
"prd",
"stg"
],
"description": "Plastic SCM environment. Values: 'prd' (production) or 'stg' (staging)"
},
"WindowsGitBinary": {
"type": "string",
"enum": [
"cygwin",
"native"
],
"description": "Windows Git binary type. - cygwin: Use Cygwin version of git - native: Use native Windows version of git"
},
"SupportedPlasticEncryptionMethod": {
"type": "string",
"enum": [
"AES128",
"AES192",
"AES256"
],
"description": "Plastic SCM encryption method. Values: 'AES128', 'AES192', or 'AES256' (Advanced Encryption Standard with key size)"
},
"OauthRepositoryOwner": {
"description": "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.",
"properties": {
"login": {
"type": "string",
"nullable": true,
"example": "unity"
},
"name": {
"type": "string",
"nullable": true,
"example": "Unity"
},
"avatar_url": {
"type": "string",
"nullable": true,
"example": "https://github.com/unity.png"
},
"html_url": {
"type": "string",
"nullable": true,
"example": "https://github.com/unity"
}
},
"type": "object",
"additionalProperties": false
},
"OauthRepository": {
"description": "The OAuth-connected repository that a project is bound to. Mirrors the `OAuthRepository` subdocument in `src/shared/models/scm.ts`.",
"properties": {
"owner": {
"$ref": "#/components/schemas/OauthRepositoryOwner"
},
"clone_url": {
"type": "string",
"nullable": true,
"example": "https://github.com/unity/example.git"
},
"archived_clone_url": {
"type": "string",
"nullable": true,
"example": "https://github.com/unity/example.git"
},
"forks": {
"type": "integer",
"format": "int64",
"example": 0,
"minimum": 0
},
"watchers": {
"type": "integer",
"format": "int64",
"example": 0,
"minimum": 0
},
"full_name": {
"type": "string",
"nullable": true,
"example": "unity/example"
},
"name": {
"type": "string",
"nullable": true,
"example": "example"
},
"scm": {
"type": "string",
"nullable": true,
"example": "git"
},
"provider_id": {
"type": "string",
"nullable": true,
"example": "gh-1234"
}
},
"type": "object",
"additionalProperties": false
},
"OauthProviderSettings": {
"description": "Base OAuth provider settings (shared by GitHub, GitLab, Bitbucket, and extended by Azure OAuth)",
"properties": {
"repository": {
"$ref": "#/components/schemas/OauthRepository"
},
"token": {
"type": "string",
"nullable": true,
"example": "token",
"writeOnly": true
},
"refreshToken": {
"type": "string",
"example": "refreshToken",
"writeOnly": true
},
"expiration": {
"type": "string",
"format": "date-time",
"example": "2025-12-31T23:59:59.000Z",
"writeOnly": true
},
"expirationInterval": {
"type": "integer",
"format": "int64",
"example": 0,
"minimum": 0,
"writeOnly": true
}
},
"type": "object",
"additionalProperties": false
},
"BitbucketOauth": {
"description": "Bitbucket OAuth configuration (extends base OAuth provider settings)",
"properties": {
"repository": {
"$ref": "#/components/schemas/OauthRepository"
},
"token": {
"type": "string",
"nullable": true,
"example": "token",
"writeOnly": true
},
"refreshToken": {
"type": "string",
"example": "refreshToken",
"writeOnly": true
},
"expiration": {
"type": "string",
"format": "date-time",
"example": "2025-12-31T23:59:59.000Z",
"writeOnly": true
},
"expirationInterval": {
"type": "integer",
"format": "int64",
"example": 0,
"minimum": 0,
"writeOnly": true
},
"workspace": {
"type": "string",
"example": "my-workspace"
}
},
"type": "object",
"additionalProperties": false
},
"AzureOauth": {
"description": "Azure OAuth configuration (extends base OAuth provider settings)",
"properties": {
"repository": {
"$ref": "#/components/schemas/OauthRepository"
},
"token": {
"type": "string",
"nullable": true,
"example": "token",
"writeOnly": true
},
"refreshToken": {
"type": "string",
"example": "refreshToken",
"writeOnly": true
},
"expiration": {
"type": "string",
"format": "date-time",
"example": "2025-12-31T23:59:59.000Z",
"writeOnly": true
},
"expirationInterval": {
"type": "integer",
"format": "int64",
"example": 0,
"minimum": 0,
"writeOnly": true
},
"azureOrg": {
"type": "string",
"example": "azureOrg"
},
"azureProject": {
"type": "string",
"example": "azureProject"
}
},
"required": [
"azureOrg",
"azureProject"
],
"type": "object",
"additionalProperties": false
},
"Oauth": {
"description": "OAuth configuration for SCM providers",
"properties": {
"scm_provider": {
"type": "string",
"example": "scm_provider"
},
"temp_state": {
"type": "string",
"example": "temp_state"
},
"github": {
"$ref": "#/components/schemas/OauthProviderSettings"
},
"gitlab": {
"$ref": "#/components/schemas/OauthProviderSettings"
},
"bitbucket": {
"$ref": "#/components/schemas/BitbucketOauth"
},
"azure": {
"$ref": "#/components/schemas/AzureOauth"
}
},
"type": "object",
"additionalProperties": false
},
"CheckUrlRequestBody": {
"description": "Request body for checkUrl",
"properties": {
"type": {
"$ref": "#/components/schemas/SupportedSCMType"
},
"url": {
"type": "string",
"example": "https://github.com/unity/example-repo.git"
},
"user": {
"type": "string",
"example": "johndoe"
},
"pass": {
"type": "string",
"example": "secret123"
},
"fingerprint": {
"type": "string",
"example": "a1b2c3d4e5f6g7h8i9j0"
},
"p4authtype": {
"type": "string",
"description": "Deprecated p4-specific auth type - please use authType instead",
"example": "p4-ticket-12345"
},
"authType": {
"$ref": "#/components/schemas/SupportedAuthType"
},
"plasticAccessToken": {
"type": "string",
"example": "plastic_token_123"
},
"plasticEnvironment": {
"$ref": "#/components/schemas/SupportedPlasticEnvironment"
},
"shallowclone": {
"type": "boolean",
"example": true
},
"windowsGitBinary": {
"$ref": "#/components/schemas/WindowsGitBinary"
},
"useEncryption": {
"type": "boolean",
"example": false
},
"encryptionKey": {
"type": "string",
"example": "a1b2c3d4e5f6g7h8i9j0"
},
"encryptionMethod": {
"$ref": "#/components/schemas/SupportedPlasticEncryptionMethod"
},
"oauth": {
"$ref": "#/components/schemas/Oauth"
}
},
"required": [
"type",
"url"
],
"type": "object",
"additionalProperties": false
},
"Author": {
"description": "Git author information",
"properties": {
"email": {
"type": "string",
"example": "user@example.com"
},
"name": {
"type": "string",
"example": "John Doe"
},
"date": {
"type": "string",
"example": "2023-01-01T00:00:00Z"
}
},
"required": [
"email"
],
"type": "object",
"additionalProperties": false
},
"CommitResponse": {
"description": "Commit response",
"properties": {
"sha": {
"type": "string",
"example": "abc123def456"
},
"message": {
"type": "string",
"example": "feat: add new feature"
},
"branch": {
"type": "string",
"example": "main"
},
"timestamp": {
"type": "string",
"example": "2023-01-01T00:00:00Z"
},
"author": {
"$ref": "#/components/schemas/Author"
}
},
"required": [
"sha"
],
"type": "object",
"additionalProperties": false
},
"Record_string.any_": {
"properties": {},
"additionalProperties": {},
"type": "object",
"description": "Construct a type with a set of properties K of type T"
},
"PlasticRepoResponse": {
"description": "Plastic SCM repository response",
"properties": {
"name": {
"type": "string",
"example": "MyRepository"
},
"description": {
"type": "string",
"example": "Repository description"
},
"isPrivate": {
"type": "boolean",
"example": true
},
"defaultBranch": {
"type": "string",
"example": "main"
},
"id": {
"type": "integer",
"format": "int64",
"example": 12345,
"minimum": 0
},
"created_at": {
"type": "string",
"example": "2023-01-01T00:00:00Z"
},
"updated_at": {
"type": "string",
"example": "2023-01-01T00:00:00Z"
}
},
"required": [
"name"
],
"type": "object",
"additionalProperties": false
},
"TargetType": {
"type": "string",
"enum": [
"normal",
"projectPreview",
"editor"
]
},
"BuildStatus": {
"type": "string",
"enum": [
"unknown",
"created",
"queued",
"assignedToBuilder",
"sentToBuilder",
"started",
"restarted",
"success",
"failure",
"canceled",
"processing"
],
"description": "Build status state"
},
"ScenePreviewBuild": {
"description": "Summary of a single build attempt for a scene-preview build target. Used for both the latest build (any status) and the latest successful build.",
"properties": {
"buildNumber": {
"type": "integer",
"format": "int64",
"example": 23,
"minimum": 0
},
"buildStatus": {
"$ref": "#/components/schemas/BuildStatus"
},
"platform": {
"type": "string",
"example": "webgl"
},
"branch": {
"type": "string",
"nullable": true,
"example": "main"
},
"commitHash": {
"type": "string",
"nullable": true,
"example": "0C2E4F1D82D7E679403E32E323F798CC78348731"
},
"unityVersion": {
"type": "string",
"nullable": true,
"example": "6000.3.2f1"
},
"operatingSystem": {
"type": "string",
"nullable": true,
"example": "macos"
},
"operatingSystemVersion": {
"type": "string",
"nullable": true,
"example": "sonoma"
},
"xcodeVersion": {
"type": "string",
"nullable": true,
"example": "16.1.0"
},
"architecture": {
"type": "string",
"nullable": true,
"example": "Apple-Silicon"
},
"buildProfilePath": {
"type": "string",
"nullable": true,
"example": "Assets/settings/build profiles/development"
},
"machineType": {
"type": "string",
"nullable": true,
"example": "STANDARD - 4 vCPU, 16GB memory, 512 GB disk"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2026-06-01T00:00:00Z"
},
"completedAt": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2026-06-01T00:05:00Z"
}
},
"required": [
"buildNumber",
"buildStatus",
"platform",
"startedAt"
],
"type": "object",
"additionalProperties": false
},
"ScenePreviewResponse": {
"description": "A scene-preview build target plus its latest build (any status) and latest successful build.",
"properties": {
"buildTargetId": {
"type": "string",
"example": "default-webgl"
},
"name": {
"type": "string",
"example": "Default WebGL"
},
"platform": {
"$ref": "#/components/schemas/Platform"
},
"enabled": {
"type": "boolean",
"example": true
},
"scenePreview": {
"type": "boolean",
"example": true
},
"targetType": {
"$ref": "#/components/schemas/TargetType"
},
"branch": {
"type": "string",
"nullable": true,
"example": "main"
},
"buildProfilePath": {
"type": "string",
"nullable": true,
"example": "Assets/settings/build profiles/development"
},
"latestBuild": {
"$ref": "#/components/schemas/ScenePreviewBuild"
},
"latestSuccessfulBuild": {
"$ref": "#/components/schemas/ScenePreviewBuild"
}
},
"required": [
"buildTargetId",
"name",
"platform",
"enabled",
"scenePreview"
],
"type": "object",
"additionalProperties": false
},
"RetentionPolicyType": {
"type": "string",
"enum": [
"timeLimitDays",
"buildCountLimit"
],
"description": "Retention policy type"
},
"RetentionPolicyResponse": {
"description": "Retention policy response object containing retention policy details",
"properties": {
"guid": {
"type": "string",
"description": "The unique identifier (GUID) for this retention policy",
"example": "550e8400-e29b-41d4-a716-446655440000"
},
"type": {
"$ref": "#/components/schemas/RetentionPolicyType"
},
"retentionValue": {
"type": "integer",
"format": "int64",
"description": "The retention value (e.g., number of days or builds to retain)",
"example": 30,
"minimum": 0
},
"retainLogs": {
"type": "boolean",
"description": "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.",
"example": false
},
"enabled": {
"type": "boolean",
"description": "Whether this retention policy is active. When false, the retention worker skips the policy and no build attempts are deleted for it.",
"example": true
}
},
"required": [
"guid",
"type",
"retentionValue",
"retainLogs",
"enabled"
],
"type": "object",
"additionalProperties": false
},
"CreateRetentionPolicyRequest": {
"description": "Request body for creating a retention policy",
"properties": {
"type": {
"$ref": "#/components/schemas/RetentionPolicyType"
},
"retentionValue": {
"type": "integer",
"format": "int64",
"description": "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`.",
"example": 30,
"minimum": 1
},
"retainLogs": {
"type": "boolean",
"description": "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.",
"example": false,
"default": false
},
"enabled": {
"type": "boolean",
"description": "Whether this retention policy is active. When false, the retention worker skips the policy and no build attempts are deleted for it.",
"example": true,
"default": true
}
},
"required": [
"type",
"retentionValue"
],
"type": "object",
"additionalProperties": false
},
"UpdateRetentionPolicyRequest": {
"description": "Request body for updating a retention policy",
"properties": {
"retentionValue": {
"type": "integer",
"format": "int64",
"description": "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.",
"example": 30,
"minimum": 1
},
"retainLogs": {
"type": "boolean",
"description": "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.",
"example": false
},
"enabled": {
"type": "boolean",
"description": "Whether this retention policy is active. When false, the retention worker skips the policy and no build attempts are deleted for it.",
"example": true
}
},
"type": "object",
"additionalProperties": false
},
"CacheStrategy": {
"type": "string",
"enum": [
"none",
"library",
"workspace",
"boostdisk",
"inherit"
],
"default": "inherit",
"description": "Cache strategy for project builds. - none: Do not use caching - library: Cache the Library folder - workspace: Cache the entire workspace - boostdisk: Use a persistent data disk - inherit: Use the organization level cache strategy"
},
"CompressionLevel": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"none"
],
"default": "1",
"description": "Compression level for cache or artifacts. Values: 'none' (no compression) or '1' through '9' (higher numbers = more compression)"
},
"ScmResponse": {
"description": "Source control management (SCM) configuration response",
"properties": {
"type": {
"$ref": "#/components/schemas/SupportedSCMType"
},
"url": {
"type": "string",
"description": "The URL of this project's source control repository.",
"example": "git@github.com:UnityTechnologies/exampleProject.git"
},
"url_buildjob": {
"type": "string",
"nullable": true,
"description": "Overrides `url` for the build job only, such as when the builder reaches the repository over a VPN.",
"example": "https://git.internal.example.com/org/repo.git"
},
"user": {
"type": "string",
"description": "The user that is authenticated to access this project's source control system.",
"example": "build_automat_service_account"
},
"pass": {
"type": "string",
"description": "The redacted password used to authenticate to this project's source control system.",
"example": "********",
"writeOnly": true
},
"fingerprint": {
"type": "string",
"description": "If using Perforce, this is the fingerprint of the server certificate."
},
"authType": {
"$ref": "#/components/schemas/SupportedAuthType"
},
"plasticAccessToken": {
"type": "string",
"description": "If using UVCS, this is the access token used to authenticate to the repository.",
"writeOnly": true
},
"shallowclone": {
"type": "boolean",
"description": "When cloning a repository, whether to perform a shallow clone.",
"example": false
},
"windowsGitBinary": {
"$ref": "#/components/schemas/WindowsGitBinary"
},
"useEncryption": {
"type": "boolean",
"description": "If using UVCS, whether the repository is encrypted or not.",
"example": false
},
"encryptionKey": {
"type": "string",
"description": "If using an encrypted UVCS repository, this refers to the key used for encryption."
},
"encryptionMethod": {
"$ref": "#/components/schemas/SupportedPlasticEncryptionMethod"
},
"plasticEnvironment": {
"$ref": "#/components/schemas/SupportedPlasticEnvironment"
},
"oauth": {
"$ref": "#/components/schemas/Oauth"
}
},
"type": "object",
"additionalProperties": false
},
"LegacyProjectSettings": {
"description": "Legacy project settings including cache strategy and SCM configuration",
"properties": {
"remoteCacheStrategy": {
"$ref": "#/components/schemas/CacheStrategy"
},
"cacheCompressionLevel": {
"$ref": "#/components/schemas/CompressionLevel"
},
"artifactCompressionLevel": {
"$ref": "#/components/schemas/CompressionLevel"
},
"scm": {
"$ref": "#/components/schemas/ScmResponse"
}
},
"required": [
"remoteCacheStrategy",
"cacheCompressionLevel",
"artifactCompressionLevel",
"scm"
],
"type": "object",
"additionalProperties": false
},
"Record_string.boolean_": {
"properties": {},
"additionalProperties": {
"type": "boolean"
},
"type": "object",
"description": "Construct a type with a set of properties K of type T"
},
"Links": {
"description": "Collection of links related to a project",
"properties": {
"self": {
"$ref": "#/components/schemas/Link"
},
"list_buildtargets": {
"$ref": "#/components/schemas/Link"
},
"latest_builds": {
"$ref": "#/components/schemas/Link"
},
"revoke_all_shared": {
"$ref": "#/components/schemas/Link"
}
},
"required": [
"self",
"list_buildtargets",
"latest_builds",
"revoke_all_shared"
],
"type": "object",
"additionalProperties": false
},
"ProjectResponse": {
"description": "Project response object containing project details and related information",
"properties": {
"settings": {
"$ref": "#/components/schemas/LegacyProjectSettings"
},
"created": {
"type": "string",
"description": "The Date and time this project was created.",
"example": "2025-01-01T18:45:00.000Z"
},
"disabled": {
"type": "boolean",
"description": "Whether this project is disabled. A disabled project cannot be built for.",
"example": false
},
"disableNotifications": {
"type": "boolean",
"description": "Whether notifications, such as build failure emails, are disabled for this project.",
"example": false
},
"generateShareLinks": {
"type": "boolean",
"description": "If enabled, a link to share the build is generated for every successful build.",
"example": false
},
"projectid": {
"type": "string",
"description": "A GUID used to uniquely identify this project.",
"example": "95a0de7c-8f1d-4d2d-8c03-9b711fac5ff8"
},
"name": {
"type": "string",
"description": "The name of the project.",
"example": "Example Project"
},
"orgName": {
"type": "string",
"description": "The name of the organization this project belongs to.",
"example": "Example Organization"
},
"serviceFlags": {
"$ref": "#/components/schemas/Record_string.boolean_"
},
"orgid": {
"type": "string",
"description": "A GUID used to uniquely identify the organization this project belongs to.",
"example": "e62c8c9f-8f1d-4d2d-8c03-9b711fac5ff8"
},
"guid": {
"type": "string",
"description": "A GUID used to uniquely identify this project.",
"example": "95a0de7c-8f1d-4d2d-8c03-9b711fac5ff8"
},
"orgFk": {
"type": "string",
"description": "A unique identifier for the organization this project belongs to.",
"example": "20066741877351"
},
"buildTimeoutMinutes": {
"type": "integer",
"format": "int64",
"description": "If a build takes longer than this many minutes, it will be automatically canceled.",
"example": 60,
"minimum": 0
},
"cachedIcon": {
"type": "string",
"description": "A link to the icon used for this project",
"example": "https://storage.googleapis.com/some-random-bucket/.../icon.png"
},
"links": {
"$ref": "#/components/schemas/Links"
}
},
"required": [
"created",
"disabled",
"disableNotifications",
"generateShareLinks",
"projectid",
"name",
"orgName",
"orgid",
"guid",
"orgFk",
"buildTimeoutMinutes",
"cachedIcon",
"links"
],
"type": "object",
"additionalProperties": false
},
"AuditLogLineResponse": {
"properties": {
"field": {
"type": "string"
},
"label": {
"type": "string"
},
"from": {
"type": "string"
},
"to": {
"type": "string"
}
},
"required": [
"field"
],
"type": "object",
"additionalProperties": false
},
"AuditLogResponse": {
"properties": {
"scope": {
"type": "string",
"enum": [
"project",
"buildTarget",
"buildAttempt"
],
"description": "The most specific association on this entry, independent of name availability."
},
"buildTargetName": {
"type": "string",
"description": "Target name captured when this entry was written. Omitted for older entries without a snapshot."
},
"updatingUserEmail": {
"type": "string"
},
"updated": {
"type": "string",
"format": "date-time"
},
"lines": {
"items": {
"$ref": "#/components/schemas/AuditLogLineResponse"
},
"type": "array"
}
},
"required": [
"scope",
"updated",
"lines"
],
"type": "object",
"additionalProperties": false
},
"Billing": {
"description": "actual billing plan",
"properties": {
"label": {
"type": "string",
"example": "Production Build"
},
"numProjects": {
"type": "integer",
"format": "int64",
"example": 3,
"minimum": 0
},
"concurrentBuilds": {
"type": "integer",
"format": "int64",
"example": 4,
"minimum": 0
},
"cooldownMinutes": {
"type": "integer",
"format": "int64",
"example": 5,
"minimum": 0
},
"cooldownGracePeriodMinutes": {
"type": "integer",
"format": "int64",
"example": 10,
"minimum": 0
},
"collaborators": {
"type": "integer",
"format": "int64",
"example": 8,
"minimum": 0
},
"repoSizeLimitMB": {
"type": "integer",
"format": "int64",
"example": 10240,
"minimum": 0
},
"repoSizeLimitThresholdMB": {
"type": "integer",
"format": "int64",
"example": 9216,
"minimum": 0
},
"downloadLimitMB": {
"type": "integer",
"format": "int64",
"example": 5120,
"minimum": 0
},
"buildManifest": {
"type": "boolean",
"example": true
},
"libraryCaching": {
"type": "boolean",
"example": true
},
"pushExternalServices": {
"type": "boolean",
"example": true
},
"supportTickets": {
"type": "boolean",
"example": true
},
"apiAccess": {
"type": "boolean",
"example": true
},
"scheduledBuilds": {
"type": "boolean",
"example": true
},
"workspaceCaching": {
"type": "boolean",
"example": true
},
"buildingDisabled": {
"type": "boolean",
"example": true
},
"advancedFeatures": {
"items": {
"type": "string"
},
"type": "array",
"example": [
"cloudBuild",
"collaborate"
]
},
"scmTypes": {
"items": {
"$ref": "#/components/schemas/SupportedSCMType"
},
"type": "array",
"example": [
"git",
"p4"
]
}
},
"type": "object",
"additionalProperties": false
},
"EffectiveType": {
"type": "string",
"enum": [
"immediate",
"scheduled",
"custom"
],
"description": "Effective date type. - immediate: Takes effect immediately - scheduled: Takes effect at a scheduled date - custom: Takes effect at a custom date"
},
"Effective": {
"description": "Effective date information",
"properties": {
"date": {
"type": "string",
"format": "date-time",
"example": "2024-01-01T00:00:00.000Z"
},
"type": {
"$ref": "#/components/schemas/EffectiveType"
}
},
"type": "object",
"additionalProperties": false
},
"GetBillingPlansForProjectResponse": {
"description": "Response for getBillingPlansForProject",
"properties": {
"billing": {
"$ref": "#/components/schemas/Billing"
},
"effective": {
"$ref": "#/components/schemas/Effective"
}
},
"required": [
"billing",
"effective"
],
"type": "object",
"additionalProperties": false
},
"GetSSHKeyForProjectResponse": {
"description": "Response for getSSHKeyForProject",
"properties": {
"publickey": {
"type": "string",
"example": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC..."
},
"type": {
"type": "string",
"example": "type"
}
},
"type": "object",
"additionalProperties": false
},
"GetSSHKeyRawResponse": {
"description": "Response for getSSHKeyRaw",
"properties": {
"publickey": {
"type": "string",
"example": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC..."
},
"privatekey": {
"type": "string",
"example": "privatekey"
},
"type": {
"type": "string",
"example": "type"
}
},
"type": "object",
"additionalProperties": false
},
"GetStatsForProjectResponse": {
"description": "Response for getStatsForProject",
"properties": {
"jobCount": {
"type": "integer",
"format": "int64",
"example": 42,
"minimum": 0
},
"buildSuccessHealth": {
"type": "number",
"format": "double",
"example": 6.027456183070403
},
"buildPoorHealth": {
"type": "number",
"format": "double",
"example": 1.4658129805029452
},
"buildCancelHealth": {
"type": "number",
"format": "double",
"example": 5.962133916683182
},
"buildPendingHealth": {
"type": "number",
"format": "double",
"example": 5.637376656633329
},
"successfulBuilds": {
"type": "integer",
"format": "int64",
"example": 12,
"minimum": 0
},
"canceledBuilds": {
"type": "integer",
"format": "int64",
"example": 1,
"minimum": 0
},
"failedBuilds": {
"type": "integer",
"format": "int64",
"example": 3,
"minimum": 0
},
"averageTime": {
"type": "number",
"format": "double",
"example": 3.616076749251911
},
"averageWorkspaceSize": {
"type": "number",
"format": "double",
"example": 2.027123023002322
},
"averageWaitTime": {
"type": "number",
"format": "double",
"example": 4.145608029883936
},
"averageBillableTime": {
"type": "number",
"format": "double",
"example": 7.386281948385884
},
"averageBuildTime": {
"type": "number",
"format": "double",
"example": 1.2315135367772556
},
"maxConcurrentBuilds": {
"type": "integer",
"format": "int64",
"example": 4,
"minimum": 0
},
"availableConcurrentBuilds": {
"type": "integer",
"format": "int64",
"example": 2,
"minimum": 0
}
},
"type": "object",
"additionalProperties": false
},
"AutoBuildLatestOption": {
"type": "string",
"enum": [
"inherit"
],
"nullable": false,
"description": "Auto-build latest option. - inherit: Inherit the auto-build latest setting from the organization"
},
"CacheStrategySubsetType": {
"type": "string",
"enum": [
"none",
"library",
"workspace"
],
"default": "library",
"description": "Subset of cache strategies available for project settings. - none: Do not use caching - library: Cache the Library folder - workspace: Cache the entire workspace"
},
"Scm": {
"description": "Scm object",
"properties": {
"type": {
"$ref": "#/components/schemas/SupportedSCMType"
},
"url": {
"type": "string",
"nullable": true,
"example": "url"
},
"url_buildjob": {
"type": "string",
"nullable": true,
"description": "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.",
"example": "https://git.internal.example.com/org/repo.git"
},
"user": {
"type": "string",
"nullable": true,
"example": "user"
},
"pass": {
"type": "string",
"nullable": true,
"example": "pass"
},
"fingerprint": {
"type": "string",
"nullable": true,
"example": "fingerprint"
},
"p4authtype": {
"type": "string",
"nullable": true,
"description": "Deprecated p4-specific auth type - please use authType instead",
"example": "p4authtype"
},
"authType": {
"$ref": "#/components/schemas/SupportedAuthType"
},
"plasticAccessToken": {
"type": "string",
"nullable": true,
"example": "plasticAccessToken"
},
"shallowclone": {
"type": "boolean",
"example": true
},
"windowsGitBinary": {
"$ref": "#/components/schemas/WindowsGitBinary"
},
"useEncryption": {
"type": "boolean",
"example": true
},
"encryptionKey": {
"type": "string",
"nullable": true,
"example": "a1b2c3d4e5f6g7h8i9j0"
},
"encryptionMethod": {
"$ref": "#/components/schemas/SupportedPlasticEncryptionMethod"
},
"plasticEnvironment": {
"$ref": "#/components/schemas/SupportedPlasticEnvironment"
},
"oauth": {
"$ref": "#/components/schemas/Oauth"
},
"isUnityCloudDrive": {
"type": "boolean",
"description": "If true, the build will use the Unity Cloud Drive for the source code (only applies to UVCS projects).",
"example": true
},
"repo": {
"type": "string",
"nullable": true,
"description": "Which repo to use. Only applies to Plastic SCM, other SCM types configure repo on the project level.",
"example": "repo"
},
"branch": {
"type": "string",
"nullable": true,
"example": "branch"
},
"subdirectory": {
"type": "string",
"nullable": true,
"description": "subdirectory to build from",
"example": "subdirectory"
},
"client": {
"type": "string",
"nullable": true,
"description": "perforce only client workspace to build from",
"example": "client"
}
},
"type": "object",
"additionalProperties": false
},
"ProjectSettings": {
"description": "Project Settings object",
"properties": {
"autoBuildLatest": {
"$ref": "#/components/schemas/AutoBuildLatestOption"
},
"remoteCacheStrategy": {
"$ref": "#/components/schemas/CacheStrategySubsetType"
},
"cacheCompressionLevel": {
"$ref": "#/components/schemas/CompressionLevel"
},
"artifactCompressionLevel": {
"$ref": "#/components/schemas/CompressionLevel"
},
"scm": {
"$ref": "#/components/schemas/Scm"
}
},
"type": "object",
"additionalProperties": false
},
"GetProjectResponse": {
"description": "Response for getProject",
"properties": {
"name": {
"type": "string",
"example": "John Doe"
},
"projectid": {
"type": "string",
"example": "1234567890"
},
"orgName": {
"type": "string",
"example": "orgName"
},
"orgid": {
"type": "string",
"example": "1234567890"
},
"orgFk": {
"type": "string",
"example": "1234567890"
},
"guid": {
"type": "string",
"example": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
},
"created": {
"type": "string",
"format": "date-time",
"example": "2023-01-01T00:00:00Z"
},
"cachedIcon": {
"type": "string",
"example": "https://example.com/icon.png"
},
"serviceFlags": {
"$ref": "#/components/schemas/Record_string.any_"
},
"links": {
"$ref": "#/components/schemas/Record_string.Link_"
},
"disabled": {
"type": "boolean",
"example": true
},
"disableNotifications": {
"type": "boolean",
"example": true
},
"generateShareLinks": {
"type": "boolean",
"example": true
},
"buildTimeoutMinutes": {
"type": "integer",
"format": "int64",
"example": 60,
"minimum": 0
},
"settings": {
"$ref": "#/components/schemas/ProjectSettings"
}
},
"type": "object",
"additionalProperties": false
},
"UpdateProjectRequestBody": {
"description": "Request body for updateProject",
"properties": {
"name": {
"type": "string",
"example": "My Project"
},
"coppa": {
"type": "boolean",
"example": false
},
"disabled": {
"type": "boolean",
"example": false
},
"disableNotifications": {
"type": "boolean",
"example": false
},
"generateShareLinks": {
"type": "boolean",
"example": true
},
"buildTimeoutMinutes": {
"type": "integer",
"format": "int64",
"example": 60,
"minimum": 0
},
"settings": {
"$ref": "#/components/schemas/ProjectSettings"
}
},
"type": "object",
"additionalProperties": false
},
"ProjectPreviewLatestBuild": {
"description": "Latest build summary for a Project Preview build target.",
"properties": {
"buildStatus": {
"type": "string",
"example": "success"
},
"buildNumber": {
"type": "integer",
"format": "int64",
"example": 42,
"minimum": 0
},
"branch": {
"type": "string",
"example": "main"
},
"repo": {
"type": "string",
"example": "my-repo"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2026-06-01T00:00:00Z"
},
"completedAt": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2026-06-01T00:05:00Z"
},
"commitHash": {
"type": "string",
"nullable": true,
"example": "abc123def456"
}
},
"required": [
"buildStatus",
"buildNumber",
"branch",
"repo",
"startedAt"
],
"type": "object",
"additionalProperties": false
},
"ProjectPreviewRunningBuild": {
"description": "Summary of a Project Preview build that is currently in progress.",
"properties": {
"buildStatus": {
"type": "string",
"example": "started"
},
"buildNumber": {
"type": "integer",
"format": "int64",
"example": 43,
"minimum": 0
},
"branch": {
"type": "string",
"example": "main"
},
"repo": {
"type": "string",
"example": "my-repo"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2026-06-01T00:00:00Z"
},
"completedAt": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2026-06-01T00:05:00Z"
},
"commitHash": {
"type": "string",
"nullable": true,
"example": "abc123def456"
}
},
"required": [
"buildStatus",
"buildNumber",
"branch",
"repo",
"startedAt"
],
"type": "object",
"additionalProperties": false
},
"ProjectPreviewResponse": {
"description": "A Project Preview build target plus its most recent build attempt.",
"properties": {
"buildTargetId": {
"type": "string",
"example": "asset-preview-standaloneosx-master"
},
"platform": {
"type": "string",
"example": "standaloneosx"
},
"branch": {
"type": "string",
"example": "master"
},
"repo": {
"type": "string",
"nullable": true,
"example": "my-repo"
},
"subdirectory": {
"type": "string",
"nullable": true,
"example": "subdir"
},
"buildProfilePath": {
"type": "string",
"nullable": true,
"example": "Assets/Settings/MyBuildProfile.asset"
},
"cacheRepo": {
"type": "string",
"nullable": true,
"example": "myorg/myproject_cache"
},
"cacheBranch": {
"type": "string",
"nullable": true,
"example": "asset-preview-cache/abc123"
},
"isCachePopulated": {
"type": "boolean",
"example": false
},
"generateProjectPreview3D": {
"type": "boolean",
"example": false
},
"latestBuild": {
"$ref": "#/components/schemas/ProjectPreviewLatestBuild"
},
"runningBuilds": {
"items": {
"$ref": "#/components/schemas/ProjectPreviewRunningBuild"
},
"type": "array"
}
},
"required": [
"buildTargetId",
"platform",
"branch",
"isCachePopulated",
"generateProjectPreview3D",
"runningBuilds"
],
"type": "object",
"additionalProperties": false
},
"OperatingSystemVersion": {
"description": "Operating system version configuration - comprehensive DTO for all OS version use cases",
"properties": {
"name": {
"type": "string",
"example": "macOS Sonoma - Silicon"
},
"value": {
"type": "string",
"example": "sonomaSilicon"
},
"default": {
"type": "boolean",
"example": false
},
"deprecated": {
"type": "boolean",
"example": false
},
"architectures": {
"items": {
"type": "string"
},
"type": "array",
"example": [
"x64",
"arm64"
]
},
"min_unity_version": {
"type": "string",
"example": "2022.3.0f1"
},
"hidden": {
"type": "boolean",
"example": true
},
"default_xcode_version": {
"type": "string",
"example": "xcode14_0"
},
"created": {
"type": "string",
"example": "2023-01-01T00:00:00Z"
},
"unity_versions": {
"items": {
"type": "string"
},
"type": "array",
"example": [
"2022.3.0f1",
"2023.1.0f1"
]
},
"max_unity_version": {
"type": "string",
"example": "2023.2.0f1"
},
"family": {
"type": "string",
"example": "mac"
},
"xcode_versions": {
"items": {
"type": "string"
},
"type": "array",
"example": [
"xcode13_2_1",
"xcode14_0"
]
},
"finishTime": {
"type": "string",
"example": "2023-12-31T23:59:59Z"
}
},
"type": "object",
"additionalProperties": false
},
"OperatingSystemInfo": {
"description": "Represents an operating system with its family, versions, and default version.\n\nDefines the properties of an operating system in the context of supported platforms.",
"properties": {
"family": {
"type": "string",
"description": "The family of the operating system",
"example": "mac"
},
"versions": {
"items": {
"$ref": "#/components/schemas/OperatingSystemVersion"
},
"type": "array",
"description": "The versions of the operating system"
},
"defaultVersion": {
"type": "string",
"description": "The default version of the operating system",
"example": "sonomaSilicon"
}
},
"required": [
"family",
"versions",
"defaultVersion"
],
"type": "object",
"additionalProperties": false
},
"PlatformCredentialRequirementLevel": {
"type": "string",
"enum": [
"none",
"optional",
"required"
],
"description": "Platform credential requirement level."
},
"SupportedPlatformResponse": {
"description": "Defines the properties of a supported platform.",
"properties": {
"platform": {
"type": "string",
"description": "The name of the platform",
"example": "standalonewindows"
},
"name": {
"type": "string",
"description": "The name of the platform",
"example": "Windows x86"
},
"editorIcon": {
"type": "string",
"description": "The editor icon for the platform",
"example": "editorIcon"
},
"operatingSystems": {
"items": {
"$ref": "#/components/schemas/OperatingSystemInfo"
},
"type": "array",
"description": "The operating systems supported by the platform"
},
"credentials": {
"$ref": "#/components/schemas/PlatformCredentialRequirementLevel"
}
},
"required": [
"platform",
"name",
"operatingSystems",
"credentials"
],
"type": "object",
"additionalProperties": false
},
"ExchangeTokenResponse": {
"description": "Response containing Plastic SCM OAuth token exchange information",
"properties": {
"user": {
"type": "string",
"description": "The Plastic user email",
"example": "user@email.com"
},
"accessToken": {
"type": "string",
"description": "The plastic access token for the user",
"example": "TOKENabc123"
},
"refreshToken": {
"type": "string",
"description": "The Oauth refresh token",
"example": "abc7ac09-3f70-428b-ade2-971812051a9b"
},
"authAccessToken": {
"type": "string",
"description": "The service access token for the user",
"example": "dGVzdFRva2VuCg=="
},
"stagingUser": {
"type": "string",
"description": "The Plastic user email for the Plastic staging environment",
"example": "user@email.com"
},
"stagingAccessToken": {
"type": "string",
"description": "The plastic access token for the user in the Plastic staging environment",
"example": "TOKENabc123"
},
"stagingRefreshToken": {
"type": "string",
"description": "The Oauth refresh token for the Plastic staging environment",
"example": "abc7ac09-3f70-428b-ade2-971812051a9b"
},
"stagingAuthAccessToken": {
"type": "string",
"description": "The service access token for the user in the Plastic staging environment",
"example": "dGVzdFRva2VuCg=="
}
},
"required": [
"user",
"accessToken",
"refreshToken",
"authAccessToken"
],
"type": "object",
"additionalProperties": false
},
"GeographicRegion": {
"type": "string",
"enum": [
"any",
"amer",
"eur"
],
"default": "amer",
"description": "Geographic region identifier for organization location"
},
"OrgLocation": {
"description": "The location of an organization.",
"properties": {
"geographicRegion": {
"$ref": "#/components/schemas/GeographicRegion"
}
},
"type": "object",
"additionalProperties": false
},
"OrgResponse": {
"description": "The response object for an organization.",
"properties": {
"orgName": {
"type": "string",
"description": "The name of the organization.",
"example": "Unity Technologies"
},
"orgid": {
"type": "string",
"description": "The friendly id for the organization.",
"example": "unity-technologies"
},
"orgFk": {
"type": "string",
"description": "The unique identifier for the organization in the core system.",
"example": "123456"
},
"autoBuildLatest": {
"type": "boolean",
"description": "Flag that enables build targets that are linked to a Unity version like `Latest Unity 6.x` to be automatically built when the linked version is updated.",
"example": true
},
"location": {
"$ref": "#/components/schemas/OrgLocation"
}
},
"required": [
"orgName",
"orgid"
],
"type": "object",
"additionalProperties": false
},
"GetBillingPlansResponse": {
"description": "Response for getBillingPlans",
"properties": {
"billing": {
"$ref": "#/components/schemas/Billing"
},
"effective": {
"$ref": "#/components/schemas/Effective"
}
},
"required": [
"billing",
"effective"
],
"type": "object",
"additionalProperties": false
},
"GetSSHKeyForOrgResponse": {
"description": "Response for getSSHKeyForOrg",
"properties": {
"publickey": {
"type": "string",
"example": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC..."
}
},
"type": "object",
"additionalProperties": false
},
"Location": {
"description": "Location object",
"properties": {
"geographicRegion": {
"type": "string",
"example": "us-east-1"
}
},
"type": "object",
"additionalProperties": false
},
"SetOrgDataResponse": {
"description": "Response for setOrgData",
"properties": {
"autoBuildLatest": {
"type": "boolean",
"example": true
},
"location": {
"$ref": "#/components/schemas/Location"
}
},
"type": "object",
"additionalProperties": false
},
"SetOrgDataRequestBody": {
"description": "Request body for setOrgData",
"properties": {
"autoBuildLatest": {
"type": "boolean",
"example": true
},
"location": {
"$ref": "#/components/schemas/Location"
}
},
"type": "object",
"additionalProperties": false
},
"OrgConcurrencyLimitResponse": {
"properties": {
"limit": {
"type": "integer",
"format": "int64",
"description": "Builds the organization can run at the same time.",
"example": 5
},
"maxAllowable": {
"type": "integer",
"format": "int64",
"description": "Highest limit the organization is allowed to set.",
"example": 20
}
},
"required": [
"limit",
"maxAllowable"
],
"type": "object",
"additionalProperties": false
},
"SetOrgConcurrencyLimitRequestBody": {
"properties": {
"limit": {
"type": "integer",
"format": "int64",
"description": "Builds the organization can run at the same time.",
"example": 5,
"minimum": 1,
"maximum": 20
}
},
"required": [
"limit"
],
"type": "object",
"additionalProperties": false
},
"FreeTierStatusResponse": {
"properties": {
"freeTierLimitReached": {
"type": "boolean",
"description": "Whether the organization has reached its free tier build limit.",
"example": false
}
},
"required": [
"freeTierLimitReached"
],
"type": "object",
"additionalProperties": false
},
"UnityPipelineEnrollmentResponse": {
"properties": {
"enrolled": {
"type": "boolean"
}
},
"required": [
"enrolled"
],
"type": "object",
"additionalProperties": false
},
"OperatingSystemFamily": {
"type": "string",
"enum": [
"windows",
"mac"
],
"description": "Operating system family for editor configuration. - windows: Windows operating system - mac: macOS operating system"
},
"WebhookResponse": {
"description": "Webhook response",
"properties": {
"id": {
"type": "string",
"example": "webhook_123"
},
"url": {
"type": "string",
"example": "https://api.github.com/hooks"
},
"name": {
"type": "string",
"example": "web"
},
"active": {
"type": "boolean",
"example": true
},
"events": {
"type": "string",
"example": "push"
},
"created_at": {
"type": "string",
"example": "2023-01-01T00:00:00Z"
},
"updated_at": {
"type": "string",
"example": "2023-01-01T00:00:00Z"
}
},
"required": [
"id"
],
"type": "object",
"additionalProperties": false
},
"BranchResponse": {
"description": "Branch response",
"properties": {
"name": {
"type": "string",
"example": "main"
}
},
"required": [
"name"
],
"type": "object",
"additionalProperties": false
},
"RepoOwner": {
"description": "Repository owner",
"properties": {
"login": {
"type": "string",
"example": "octocat"
},
"avatar_url": {
"type": "string",
"example": "https://github.com/images/error/octocat_happy.gif"
}
},
"required": [
"login"
],
"type": "object",
"additionalProperties": false
},
"RepoResponse": {
"description": "Repository response",
"properties": {
"name": {
"type": "string",
"example": "Hello-World"
},
"full_name": {
"type": "string",
"example": "octocat/Hello-World"
},
"scm": {
"type": "string",
"enum": [
"git"
],
"nullable": false,
"example": "git"
},
"provider_id": {
"type": "string",
"example": "12345"
},
"watchers": {
"type": "integer",
"format": "int64",
"example": 80,
"minimum": 0
},
"forks": {
"type": "integer",
"format": "int64",
"example": 9,
"minimum": 0
},
"clone_url": {
"type": "string",
"example": "https://github.com/octocat/Hello-World.git"
},
"owner": {
"$ref": "#/components/schemas/RepoOwner"
}
},
"required": [
"name"
],
"type": "object",
"additionalProperties": false
},
"OperatingSystem": {
"type": "string",
"enum": [
"windows",
"mac",
"linux"
],
"default": "mac",
"description": "Operating system name (mac, windows, or linux)"
},
"DataDriveType": {
"type": "string",
"enum": [
"pooled",
"substitute"
],
"description": "Data drive type"
},
"MachineType": {
"description": "Machine type - comprehensive DTO for all machine type use cases",
"properties": {
"name": {
"type": "string",
"example": "Standard_v1"
},
"shortName": {
"type": "string",
"example": "win_standard_v1"
},
"label": {
"type": "string",
"example": "win_standard_v1"
},
"operatingSystem": {
"$ref": "#/components/schemas/OperatingSystem"
},
"operatingSystemVersions": {
"items": {
"type": "string"
},
"type": "array",
"example": [
"sonomaSilicon",
"venturaIntel"
]
},
"enabled": {
"type": "boolean",
"example": true
},
"default": {
"type": "boolean",
"example": false
},
"isBestValue": {
"type": "boolean",
"example": true
},
"freeTierEligible": {
"type": "boolean",
"example": true
},
"sku": {
"type": "string",
"example": "Standard_D2s_v3"
},
"cpuCores": {
"type": "integer",
"format": "int64",
"example": 2,
"minimum": 0
},
"memoryGB": {
"type": "integer",
"format": "int64",
"example": 8,
"minimum": 0
},
"videoMemoryGB": {
"type": "integer",
"format": "int64",
"example": 1,
"minimum": 0
},
"diskSizeGB": {
"type": "integer",
"format": "int64",
"example": 100,
"minimum": 0
},
"osDiskSizeGB": {
"type": "integer",
"format": "int64",
"example": 30,
"minimum": 0
},
"dataDriveType": {
"$ref": "#/components/schemas/DataDriveType"
}
},
"type": "object",
"additionalProperties": false
},
"BuildFailureItem": {
"properties": {
"displayName": {
"type": "string",
"description": "Human-readable display name for the failure",
"example": "Git Checkout Error"
},
"stage": {
"type": "string",
"description": "Build stage where the failure occurred",
"example": "checkout"
},
"step": {
"type": "string",
"description": "Build step where the failure occurred",
"example": "git-clone"
},
"publicMessage": {
"type": "string",
"description": "User-facing message explaining the failure",
"example": "Git authentication failed"
},
"link": {
"type": "string",
"description": "Link to documentation or help for this failure type",
"example": "https://docs.unity.com/git-setup"
},
"logline": {
"type": "integer",
"format": "int64",
"description": "Line number in the build log where the failure occurred",
"example": 123,
"minimum": 0
},
"label": {
"type": "string",
"description": "v1 API field for the failure indicator id (userservice FailureDetail.label)."
},
"failureType": {
"type": "string",
"description": "Indicator metadata type when included (non-public failure details)."
},
"failureIndicatorLabel": {
"type": "string",
"description": "Unique label identifying the failure indicator (alias aligned with v1 `label` when present)."
},
"stageMatch": {
"type": "boolean",
"description": "Whether the indicator's stage matches the actual build failure stage set by build-cli",
"example": true
}
},
"required": [
"displayName"
],
"type": "object",
"additionalProperties": false
},
"GetBuildFailuresResponse": {
"description": "Response for getBuildFailures",
"properties": {
"failures": {
"items": {
"$ref": "#/components/schemas/BuildFailureItem"
},
"type": "array",
"description": "Array of active failures detected for this build attempt"
}
},
"required": [
"failures"
],
"type": "object",
"additionalProperties": false
},
"PositiveInteger": {
"type": "integer",
"format": "int64",
"description": "Non-negative integers",
"minimum": 0
},
"FailureFeedbackType": {
"type": "string",
"enum": [
"helpful",
"not_helpful"
],
"description": "User feedback type for build failures."
},
"FailureFeedbackRequest": {
"description": "Request body for submitting failure feedback",
"properties": {
"failureIndicatorLabel": {
"type": "string",
"example": "build_failed"
},
"feedback": {
"$ref": "#/components/schemas/FailureFeedbackType"
}
},
"required": [
"failureIndicatorLabel",
"feedback"
],
"type": "object",
"additionalProperties": false
},
"FailureIndicatorLabelSummaryResponse": {
"description": "Summary response for a failure indicator label",
"properties": {
"label": {
"type": "string",
"example": "git_auth_failed"
},
"displayName": {
"type": "string",
"example": "Git Authentication Failed"
}
},
"required": [
"label",
"displayName"
],
"type": "object",
"additionalProperties": false
},
"GetFailureIndicatorLabelsResponse": {
"description": "Response containing failure indicator labels",
"properties": {
"labels": {
"items": {
"$ref": "#/components/schemas/FailureIndicatorLabelSummaryResponse"
},
"type": "array"
}
},
"required": [
"labels"
],
"type": "object",
"additionalProperties": false
},
"Record_string.string_": {
"properties": {},
"additionalProperties": {
"type": "string"
},
"type": "object",
"description": "Construct a type with a set of properties K of type T"
},
"AndroidSdkConfig": {
"description": "Android SDK configuration",
"properties": {
"name": {
"type": "string",
"example": "John Doe"
},
"value": {
"type": "string",
"example": "example-value"
}
},
"type": "object",
"additionalProperties": false
},
"GetCombinedConfigurationsResponse": {
"description": "Response for getCombinedConfigurations",
"properties": {
"machineTypes": {
"items": {
"$ref": "#/components/schemas/MachineType"
},
"type": "array"
},
"xcodeVersions": {
"items": {
"$ref": "#/components/schemas/XcodeVersion"
},
"type": "array"
},
"operatingSystemVersions": {
"items": {
"$ref": "#/components/schemas/OperatingSystemVersion"
},
"type": "array"
},
"androidSdkConfig": {
"items": {
"$ref": "#/components/schemas/AndroidSdkConfig"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"Keystore": {
"description": "Keystore object",
"properties": {
"alias": {
"type": "string",
"description": "friendly name for keystore",
"example": "my-keystore-alias"
},
"debug": {
"type": "boolean",
"description": "whether this is a debug or production keystore",
"example": true
},
"expiration": {
"type": "string",
"format": "date-time",
"description": "expiration date",
"example": "2025-12-31T23:59:59.000Z"
}
},
"type": "object",
"additionalProperties": false
},
"CredentialSigningLinks": {
"description": "Links for a signing credential: `self`, `delete`, and `projects` (only when assigned projects exist).",
"properties": {
"self": {
"$ref": "#/components/schemas/Link"
},
"delete": {
"$ref": "#/components/schemas/Link"
},
"projects": {
"items": {
"$ref": "#/components/schemas/Link"
},
"type": "array",
"example": [
{
"method": "get",
"href": "/orgs/{orgFk}/projects/{guid}/",
"meta": {
"name": "My project",
"id": "project-core-guid"
}
}
]
}
},
"type": "object",
"additionalProperties": false
},
"RegenerateAndroidDebugCredentialsForOrgResponse": {
"description": "Response for regenerateAndroidDebugCredentialsForOrg",
"properties": {
"platform": {
"$ref": "#/components/schemas/Platform"
},
"label": {
"type": "string",
"example": "Production Build"
},
"credentialid": {
"type": "string",
"example": "a7dba621-a877-43c5-8163-bda58247124e"
},
"created": {
"type": "string",
"format": "date-time",
"example": "2023-01-01T00:00:00Z"
},
"lastMod": {
"type": "string",
"format": "date-time",
"example": "2023-01-01T00:00:00Z"
},
"keystore": {
"$ref": "#/components/schemas/Keystore"
},
"links": {
"$ref": "#/components/schemas/CredentialSigningLinks"
}
},
"type": "object",
"additionalProperties": false
},
"Certificate": {
"description": "Certificate object",
"properties": {
"teamId": {
"type": "string",
"description": "generated team id from Apple",
"example": "teamId"
},
"certName": {
"type": "string",
"description": "certificate name (from the certificate)",
"example": "certName"
},
"expiration": {
"type": "string",
"format": "date-time",
"description": "expiration date",
"example": "2025-12-31T23:59:59.000Z"
},
"isDistribution": {
"type": "boolean",
"description": "if this is a distribution certificate",
"example": true
},
"issuer": {
"type": "string",
"description": "issuer of the certificate",
"example": "issuer"
},
"uploaded": {
"type": "string",
"format": "date-time",
"description": "uploaded date",
"example": "2024-01-01T00:00:00Z"
}
},
"type": "object",
"additionalProperties": false
},
"ProvisioningProfileType": {
"type": "string",
"enum": [
"developer",
"adhoc",
"appstore"
],
"description": "iOS provisioning profile type"
},
"ProvisioningProfile": {
"description": "ProvisioningProfile object",
"properties": {
"teamId": {
"type": "string",
"description": "generated team id from Apple",
"example": "teamId"
},
"bundleId": {
"type": "string",
"description": "a unique identifier (com.example.name)",
"example": "bundleId"
},
"uuid": {
"type": "string",
"description": "generated UUID of the profile",
"example": "uuid"
},
"expiration": {
"type": "string",
"format": "date-time",
"description": "expiration date",
"example": "2025-12-31T23:59:59.000Z"
},
"isEnterpriseProfile": {
"type": "boolean",
"description": "is this compiled for Apple's enterprise program",
"example": true
},
"type": {
"$ref": "#/components/schemas/ProvisioningProfileType"
},
"numDevices": {
"type": "integer",
"format": "int64",
"description": "number of devices provisioned for this certificate",
"example": 42,
"minimum": 0
},
"uploaded": {
"type": "string",
"description": "uploaded date",
"example": "uploaded"
},
"provisionedDevices": {
"items": {
"type": "string"
},
"type": "array",
"description": "provisioned udids",
"example": [
"device1",
"device2"
]
}
},
"type": "object",
"additionalProperties": false
},
"AddCredentialsIosForOrgResponse": {
"description": "Response for addCredentialsIosForOrg",
"properties": {
"platform": {
"$ref": "#/components/schemas/Platform"
},
"label": {
"type": "string",
"example": "Production Build"
},
"credentialid": {
"type": "string",
"example": "a7dba621-a877-43c5-8163-bda58247124e"
},
"created": {
"type": "string",
"format": "date-time",
"example": "2023-01-01T00:00:00Z"
},
"lastMod": {
"type": "string",
"format": "date-time",
"example": "2023-01-01T00:00:00Z"
},
"certificate": {
"$ref": "#/components/schemas/Certificate"
},
"provisioningProfile": {
"$ref": "#/components/schemas/ProvisioningProfile"
},
"links": {
"$ref": "#/components/schemas/CredentialSigningLinks"
}
},
"type": "object",
"additionalProperties": false
},
"AddCredentialsOsxForOrgResponse": {
"description": "Response for addCredentialsOsxForOrg",
"properties": {
"platform": {
"$ref": "#/components/schemas/Platform"
},
"label": {
"type": "string",
"example": "Production Build"
},
"credentialid": {
"type": "string",
"example": "a7dba621-a877-43c5-8163-bda58247124e"
},
"created": {
"type": "string",
"format": "date-time",
"example": "2023-01-01T00:00:00Z"
},
"lastMod": {
"type": "string",
"format": "date-time",
"example": "2023-01-01T00:00:00Z"
},
"certificate": {
"$ref": "#/components/schemas/Certificate"
},
"providerName": {
"type": "string",
"example": "Apple Developer"
},
"appleIdUsername": {
"type": "string",
"example": "developer@example.com"
},
"links": {
"$ref": "#/components/schemas/CredentialSigningLinks"
}
},
"type": "object",
"additionalProperties": false
},
"AddCredentialsUwpForOrgResponse": {
"description": "Response for addCredentialsUwpForOrg",
"properties": {
"platform": {
"$ref": "#/components/schemas/Platform"
},
"label": {
"type": "string",
"example": "Production Build"
},
"credentialid": {
"type": "string",
"example": "a7dba621-a877-43c5-8163-bda58247124e"
},
"created": {
"type": "string",
"format": "date-time",
"example": "2023-01-01T00:00:00Z"
},
"lastMod": {
"type": "string",
"format": "date-time",
"example": "2023-01-01T00:00:00Z"
},
"certificate": {
"$ref": "#/components/schemas/Certificate"
},
"links": {
"$ref": "#/components/schemas/CredentialSigningLinks"
}
},
"type": "object",
"additionalProperties": false
},
"GetAllAndroidResponse": {
"description": "Response for getAllAndroid and getAllAndroidForOrg",
"properties": {
"platform": {
"$ref": "#/components/schemas/Platform"
},
"label": {
"type": "string",
"example": "Auto Generated Debug Keystore"
},
"credentialid": {
"type": "string",
"example": "a7dba621-a877-43c5-8163-bda58247124e"
},
"created": {
"type": "string",
"format": "date-time",
"example": "2015-08-27T22:29:00.023Z"
},
"lastMod": {
"type": "string",
"format": "date-time",
"example": "2015-08-27T22:29:00.023Z"
},
"keystore": {
"$ref": "#/components/schemas/Keystore"
},
"links": {
"$ref": "#/components/schemas/CredentialSigningLinks"
}
},
"type": "object",
"additionalProperties": false
},
"GetAllIosResponse": {
"description": "Response for getAllIos and getAllIosForOrg",
"properties": {
"platform": {
"$ref": "#/components/schemas/Platform"
},
"label": {
"type": "string",
"example": "Beta Credentials"
},
"credentialid": {
"type": "string",
"example": "a7dba621-a877-43c5-8163-bda58247124e"
},
"created": {
"type": "string",
"format": "date-time",
"example": "2015-08-27T22:29:00.023Z"
},
"lastMod": {
"type": "string",
"format": "date-time",
"example": "2015-08-27T22:29:00.023Z"
},
"certificate": {
"$ref": "#/components/schemas/Certificate"
},
"provisioningProfile": {
"$ref": "#/components/schemas/ProvisioningProfile"
},
"links": {
"$ref": "#/components/schemas/CredentialSigningLinks"
}
},
"type": "object",
"additionalProperties": false
},
"GetAllOsxResponse": {
"description": "Response for getAllOsx and getAllOsxForOrg",
"properties": {
"platform": {
"$ref": "#/components/schemas/Platform"
},
"label": {
"type": "string",
"example": "Beta Credentials"
},
"credentialid": {
"type": "string",
"example": "a7dba621-a877-43c5-8163-bda58247124e"
},
"created": {
"type": "string",
"format": "date-time",
"example": "2015-08-27T22:29:00.023Z"
},
"lastMod": {
"type": "string",
"format": "date-time",
"example": "2015-08-27T22:29:00.023Z"
},
"certificate": {
"$ref": "#/components/schemas/Certificate"
},
"providerName": {
"type": "string",
"example": "Apple Developer"
},
"appleIdUsername": {
"type": "string",
"example": "developer@example.com"
},
"links": {
"$ref": "#/components/schemas/CredentialSigningLinks"
}
},
"type": "object",
"additionalProperties": false
},
"GetAllUwpResponse": {
"description": "Response for getAllUwp and getAllUwpForOrg",
"properties": {
"platform": {
"$ref": "#/components/schemas/Platform"
},
"label": {
"type": "string",
"example": "Beta Credentials"
},
"credentialid": {
"type": "string",
"example": "a7dba621-a877-43c5-8163-bda58247124e"
},
"created": {
"type": "string",
"format": "date-time",
"example": "2015-08-27T22:29:00.023Z"
},
"lastMod": {
"type": "string",
"format": "date-time",
"example": "2015-08-27T22:29:00.023Z"
},
"certificate": {
"$ref": "#/components/schemas/Certificate"
},
"links": {
"$ref": "#/components/schemas/CredentialSigningLinks"
}
},
"type": "object",
"additionalProperties": false
},
"ChangelogItem": {
"description": "Individual changelog entry item",
"properties": {
"logType": {
"type": "string",
"nullable": true,
"description": "The type of changelog entry",
"example": "unity"
},
"message": {
"type": "string",
"nullable": true,
"description": "The changelog message content",
"example": "Unity 2022.3.15f1 is now available"
},
"created": {
"type": "string",
"nullable": true,
"description": "The date when this changelog entry was created",
"example": "2023-11-20T17:01:32.774Z"
},
"releaseVersion": {
"type": "string",
"nullable": true,
"description": "The release this entry shipped in. Null for stored entries, which predate versioned notes.",
"example": "2026_07_R2"
}
},
"required": [
"logType",
"message",
"created",
"releaseVersion"
],
"type": "object",
"additionalProperties": false
},
"CacheCompressionLevelResponse": {
"description": "Cache compression level response",
"properties": {
"level": {
"type": "string",
"example": "1"
},
"label": {
"type": "string",
"example": "Fast"
},
"isDefault": {
"type": "boolean",
"example": true
}
},
"required": [
"level",
"label"
],
"type": "object",
"additionalProperties": false
},
"CacheCompressionListResponse": {
"description": "Cache compression list response",
"properties": {
"name": {
"type": "string",
"nullable": true,
"example": "my-project"
},
"levels": {
"items": {
"$ref": "#/components/schemas/CacheCompressionLevelResponse"
},
"type": "array"
}
},
"required": [
"levels"
],
"type": "object",
"additionalProperties": false
},
"Cache": {
"description": "Cache object",
"properties": {
"compressionMethod": {
"type": "string",
"description": "Sets the compression mode for caching workspace or Library. Defaults to gzip",
"example": "compressionMethod"
}
},
"type": "object",
"additionalProperties": false
},
"Xcode": {
"description": "Xcode object",
"properties": {
"useArchiveAndExport": {
"type": "boolean",
"example": true
},
"customFastlaneConfigPath": {
"type": "string",
"description": "The path (including file name) from the project root to the custom FastLane configuration json file to configure multiple provisioning files, or customize the FastLane build process.\n\nSee https://forum.unity.com/threads/xcode-9-multiple-provisioning-profiles.545121/\n\nWill look for Assets/ucb_xcode_fastlane.json by default, if not specified.",
"example": "customFastlaneConfigPath"
},
"uploadXCArchive": {
"type": "boolean",
"description": "Upload the XCArchive file produced by the build. This file will be downloadable from the dashboard if this property is true.",
"example": true
},
"uploadXcodeProject": {
"type": "boolean",
"description": "upload xcode project with the build artifacts.",
"example": true
},
"shouldNotarize": {
"type": "boolean",
"description": "Only used with OSX targets, this triggers signing and notarization process for the executable.",
"example": true
}
},
"type": "object",
"additionalProperties": false
},
"Android": {
"description": "Android object",
"properties": {
"buildAppBundle": {
"type": "boolean",
"example": true
},
"buildAssetPacks": {
"type": "boolean",
"example": true
},
"androidSDKVersion": {
"type": "string",
"description": "Android SDK Version",
"example": "androidSDKVersion"
}
},
"type": "object",
"additionalProperties": false
},
"PlayerExporter": {
"description": "PlayerExporter object",
"properties": {
"sceneList": {
"items": {
"type": "string"
},
"type": "array",
"description": "A list of scenes to build overriding those specified in the Build Settings menu of your Unity project.",
"example": [
"Assets/Scenes/Main.unity",
"Assets/Scenes/Game.unity"
]
},
"buildOptions": {
"items": {
"type": "string"
},
"type": "array",
"description": "Unity Editor build options. Use `BuildOptions.Development` and `BuildOptions.AllowDebugging` to create a development build.",
"example": [
"Development",
"AllowDebugging"
]
},
"export": {
"type": "boolean",
"description": "Enable exporting a player from Unity (i.e. running BuildPipeline.BuildPlayer). Enabling this is equivalent to disabling Content-only Build in Build Target on Developer Dashboard. In general, this should be true, unless you are doing something like an asset bundle only build or unit test only build without generating an actual build artifact.",
"example": true
}
},
"type": "object",
"additionalProperties": false
},
"PlayerSettingsAndroid": {
"description": "Android player settings object.\n\nThis is `advanced.unity.playerSettings.Android` and is a different shape from `advanced.android` (see `Android`), which carries the build-system options.",
"properties": {
"useAPKExpansionFiles": {
"type": "boolean",
"description": "Whether to make split binary application builds. Surfaced in the dashboard as \"Make split binary application builds\" and used to derive Unity's `splitApplicationBinary` player setting at build time.",
"example": true
}
},
"type": "object",
"additionalProperties": false
},
"Switch": {
"description": "Switch object",
"properties": {
"useSwitchCPUProfiler": {
"type": "boolean",
"description": "Whether to use CPU profiler or not",
"example": true
}
},
"type": "object",
"additionalProperties": false
},
"PlayerSettings": {
"description": "PlayerSettings object",
"properties": {
"Android": {
"$ref": "#/components/schemas/PlayerSettingsAndroid"
},
"Switch": {
"$ref": "#/components/schemas/Switch"
}
},
"type": "object",
"additionalProperties": false
},
"AndroidBuildSystemType": {
"type": "string",
"enum": [
"internal",
"gradle"
],
"description": "Android build system type. - internal: Use internal build system - gradle: Use Gradle build system"
},
"StandaloneBuildSubtargetType": {
"type": "string",
"enum": [
"Player",
"Server"
],
"description": "Standalone build subtarget type"
},
"SwitchRomCompressionTypeType": {
"type": "string",
"enum": [
"None",
"LZ4"
],
"description": "Nintendo Switch ROM compression type"
},
"SwitchGraphicsDebuggingOption": {
"type": "string",
"enum": [
"EnableLowLevelGraphicsDebugger_WithoutShaderSourceInfo",
"EnableLowLevelGraphicsDebugger_WithShaderSourceInfo",
"EnableLowLevelGraphicsDebugger_WithShaderSourceInfoAndAftermath",
"EnableNVNGraphicsDebugger",
"EnableNVNGraphicsDebuggerAndShaderDebugging",
"EnableNVNDrawValidation_Light",
"EnableNVNDrawValidation_Heavy"
],
"description": "Nintendo Switch graphics debugging option"
},
"SwitchScriptingDebuggingTransportOption": {
"type": "string",
"enum": [
"ScriptDebuggingOverHTCS",
"ScriptDebuggingOverNetwork"
],
"description": "Nintendo Switch scripting debugging transport option"
},
"EditorUserBuildSettings": {
"description": "EditorUserBuildSettings object",
"properties": {
"androidBuildSystem": {
"$ref": "#/components/schemas/AndroidBuildSystemType"
},
"standaloneBuildSubtarget": {
"$ref": "#/components/schemas/StandaloneBuildSubtargetType"
},
"switchCreateRomFile": {
"type": "boolean",
"description": "Whether to generate ROM file or not",
"example": true
},
"switchEnableRomCompression": {
"type": "boolean",
"description": "Whether to enable ROM compression or not",
"example": true
},
"switchRomCompressionType": {
"$ref": "#/components/schemas/SwitchRomCompressionTypeType"
},
"switchRomCompressionLevel": {
"type": "integer",
"format": "int64",
"description": "Which ROM compression level to use",
"example": 1,
"minimum": 0,
"maximum": 16
},
"switchRomCompressionConfig": {
"type": "string",
"description": "Compression config. Can be a plain string or a path to a file",
"example": "switchRomCompressionConfig"
},
"switchSaveAdf": {
"type": "boolean",
"description": "Whether to save .ADF file or not",
"example": true
},
"switchGraphicsDebugging": {
"$ref": "#/components/schemas/SwitchGraphicsDebuggingOption"
},
"switchEnableHeapInspector": {
"type": "boolean",
"description": "Whether to enable Heap Inspector or Not",
"example": true
},
"switchEnableMemoryTracker": {
"type": "boolean",
"description": "Whether to enable Memory Tracker or Not",
"example": true
},
"switchWaitForMemoryTrackerOnStartup": {
"type": "boolean",
"description": "Whether to Wait For Memory Tracker On Startup or not",
"example": true
},
"switchEnableDebugPad": {
"type": "boolean",
"description": "Whether to Enable Debug Pad or not",
"example": true
},
"switchRedirectWritesToHostMount": {
"type": "boolean",
"description": "Whether to Redirect Writes to Host Mount or not",
"example": true
},
"switchScriptingDebuggingTransport": {
"$ref": "#/components/schemas/SwitchScriptingDebuggingTransportOption"
}
},
"type": "object",
"additionalProperties": false
},
"AssetBundles": {
"description": "AssetBundles object",
"properties": {
"buildBundles": {
"type": "boolean",
"description": "enable asset bundle builds for this target",
"example": true
},
"basePath": {
"type": "string",
"description": "base path relative to Assets folder where asset bundles are output. Default is 'AssetBundles'",
"example": "basePath"
},
"buildAssetBundleOptions": {
"type": "string",
"description": "comma separated list of flags from BuildAssetBundleOptions. see https://docs.unity3d.com/ScriptReference/BuildAssetBundleOptions.html",
"example": "buildAssetBundleOptions"
},
"copyToStreamingAssets": {
"type": "boolean",
"description": "copy bundles to streaming assets folder, which will be packaged into the exported player.",
"example": true
},
"copyBundlePatterns": {
"items": {
"type": "string"
},
"type": "array",
"description": "array of patterns to match (C# Regular Expressions) when copying asset bundle files. By default, all bundles will be copied.",
"example": [
"*.bundle",
"*.unity3d"
]
},
"uploadAssetBundles": {
"type": "boolean",
"description": "upload asset bundles with the build artifacts.",
"example": true
}
},
"type": "object",
"additionalProperties": false
},
"ContentUpdateSettings": {
"description": "ContentUpdateSettings object",
"properties": {
"contentStatePath": {
"type": "string",
"description": "The path to a Content State .bin file relative to the project root",
"example": "contentStatePath"
},
"linkedTargetId": {
"type": "string",
"description": "The Id of the build target to obtain a Content State .bin file from",
"example": "linkedTargetId"
}
},
"type": "object",
"additionalProperties": false
},
"AddressableBuildLayoutReportFileFormatType": {
"type": "string",
"enum": [
"JSON",
"TXT"
],
"description": "Addressable build layout report file format"
},
"Addressables": {
"description": "Addressables object",
"properties": {
"buildAddressables": {
"type": "boolean",
"description": "enable addressable builds for this target",
"example": true
},
"uploadAddressables": {
"type": "boolean",
"description": "upload addressable assets with the build artifacts.",
"example": true
},
"contentUpdate": {
"type": "boolean",
"description": "Update a previously built player with new Addressable Content.",
"example": true
},
"profileName": {
"type": "string",
"description": "which addressables profile should be used for the build",
"example": "DefaultProfile"
},
"failedAddressablesFailsBuild": {
"type": "boolean",
"description": "Exit and mark the build as failed if an error occurs when addressables are built",
"example": true
},
"contentUpdateSettings": {
"$ref": "#/components/schemas/ContentUpdateSettings"
},
"generateBuildLayout": {
"type": "boolean",
"description": "Whether to generate the bundle build layout report.",
"example": true
},
"buildLayoutReportFileFormat": {
"$ref": "#/components/schemas/AddressableBuildLayoutReportFileFormatType"
}
},
"type": "object",
"additionalProperties": false
},
"Unity": {
"description": "Unity build configuration object",
"properties": {
"preExportMethod": {
"type": "string",
"description": "The fully-qualified name of a public static method you want us to call before we start the Unity build process.\n\nFor example: ClassName.NeatMethod or NameSpace.ClassName.NeatMethod. No trailing parenthesis, and it can't have the same name as your Post-Export method!",
"example": "preExportMethod"
},
"postExportMethod": {
"type": "string",
"description": "The fully-qualified name of a public static method you want us to call after we finish the Unity build process (but before Xcode).\n\nFor example: ClassName.CoolMethod or NameSpace.ClassName.CoolMethod. No trailing parenthesis, and it can't have the same name as your Post-Export method! This method must accept a string parameter, which will receive the path to the exported Unity player (or Xcode project in the case of iOS).",
"example": "postExportMethod"
},
"preBuildScript": {
"type": "string",
"description": "Relative path to the script that should be run before the build process starts.",
"example": "preBuildScript"
},
"postBuildScript": {
"type": "string",
"description": "Relative path to the script that should be run after the build process finishes.",
"example": "postBuildScript"
},
"preBuildScriptFailsBuild": {
"type": "boolean",
"description": "If this is true, a non-zero exit code on your preBuildScript will cause your build to be marked as Failed",
"example": true
},
"postBuildScriptFailsBuild": {
"type": "boolean",
"description": "If this is true, a non-zero exit code on your postBuildScript will cause your build to be marked as Failed",
"example": true
},
"scriptingDefineSymbols": {
"type": "string",
"description": "Enter the names of the symbols you want to define for iOS. These symbols can then be used as the conditions for #if directives just like the built-in ones. (i.e. #IF MYDEFINE or #IF AMAZON)",
"example": "scriptingDefineSymbols"
},
"playerExporter": {
"$ref": "#/components/schemas/PlayerExporter"
},
"playerSettings": {
"$ref": "#/components/schemas/PlayerSettings"
},
"editorUserBuildSettings": {
"$ref": "#/components/schemas/EditorUserBuildSettings"
},
"assetBundles": {
"$ref": "#/components/schemas/AssetBundles"
},
"addressables": {
"$ref": "#/components/schemas/Addressables"
},
"runUnitTests": {
"type": "boolean",
"description": "Run any unit tests your project has when a build happens.",
"example": true
},
"runEditModeTests": {
"type": "boolean",
"description": "Should Edit Mode unit tests be run? NOTE: requires runUnitTests to be true and building with Unity 5.6 or newer.",
"example": true
},
"runPlayModeTests": {
"type": "boolean",
"description": "Should Play Mode unit tests be run? NOTE: requires runUnitTests to be true and building with Unity 5.6 or newer.",
"example": true
},
"failedUnitTestFailsBuild": {
"type": "boolean",
"description": "Mark builds as failed if the unit tests do not pass.",
"example": true
},
"unitTestMethod": {
"type": "string",
"description": "LEGACY - The Unity method to call when running unit tests (only supported in Unity 5.2 and lower).",
"example": "unitTestMethod"
},
"disableAssemblyUpdater": {
"type": "boolean",
"description": "Disable assembly updater when running Unity",
"example": true
},
"acceptApiUpdate": {
"type": "boolean",
"description": "Accept API changes when running Unity",
"example": true
},
"enableLightBake": {
"type": "boolean",
"description": "Enable lightmap baking (disabled by default since it is very slow and usually unnecessary)",
"example": true
}
},
"type": "object",
"additionalProperties": false
},
"UWPWindowsSDKVersionType": {
"type": "string",
"enum": [
"10.0.17134.0",
"10.0.17763.0",
"10.0.18362.0",
"10.0.19041.0",
"10.0.20348.0",
"10.0.22621.0",
"10.0.22000.0"
],
"description": "Universal Windows Platform Windows SDK version"
},
"UWPVisualStudioVersionType": {
"type": "string",
"enum": [
"2019",
"2022"
],
"description": "Universal Windows Platform Visual Studio version"
},
"UWPWSAArchitectureType": {
"type": "string",
"enum": [
"ARM",
"ARM64",
"x86",
"x64"
],
"description": "Universal Windows Platform WSA architecture"
},
"UWPCapability": {
"type": "string",
"enum": [
"EnterpriseAuthentication",
"InternetClient",
"InternetClientServer",
"MusicLibrary",
"PicturesLibrary",
"PrivateNetworkClientServer",
"SharedUserCertificates",
"VideosLibrary",
"WebCam",
"RemovableStorage",
"Proximity",
"Microphone",
"Location",
"HumanInterfaceDevice",
"AllJoyn",
"BlockedChatMessages",
"Chat",
"CodeGeneration",
"Objects3D",
"PhoneCall",
"UserAccountInformation",
"VoipCall",
"Bluetooth",
"SpatialPerception",
"InputInjectionBrokered",
"Appointments",
"BackgroundMediaPlayback",
"Contacts",
"LowLevelDevices",
"OfflineMapsManagement",
"PhoneCallHistoryPublic",
"PointOfService",
"RecordedCallsFolder",
"RemoteSystem",
"SystemManagement",
"UserDataTasks",
"UserNotificationListener",
"GazeInput"
],
"description": "Universal Windows Platform capability"
},
"UWPTargetFamilyType": {
"type": "string",
"enum": [
"Universal",
"Desktop",
"Mobile",
"Xbox",
"Holographic",
"IoT",
"IoTHeadless"
],
"description": "Universal Windows Platform target family"
},
"UWPBuildTypeType": {
"type": "string",
"enum": [
"D3D",
"XAML",
"ExecutableOnly"
],
"description": "Universal Windows Platform build type"
},
"UWPMSBuildConfigurationType": {
"type": "string",
"enum": [
"Debug",
"Release",
"Master",
"MasterWithLTCG"
],
"description": "Universal Windows Platform MSBuild configuration"
},
"Uwp": {
"description": "Uwp object",
"properties": {
"windowsSDKVersion": {
"$ref": "#/components/schemas/UWPWindowsSDKVersionType"
},
"visualStudioVersion": {
"$ref": "#/components/schemas/UWPVisualStudioVersionType"
},
"wsaArchitecture": {
"$ref": "#/components/schemas/UWPWSAArchitectureType"
},
"capabilities": {
"items": {
"$ref": "#/components/schemas/UWPCapability"
},
"type": "array",
"description": "Sets the capabilities of the build UWP application",
"example": [
"EnterpriseAuthentication",
"InternetClient"
]
},
"targetFamily": {
"items": {
"$ref": "#/components/schemas/UWPTargetFamilyType"
},
"type": "array",
"description": "Sets the target device family for the build",
"example": [
"Universal",
"Desktop"
]
},
"buildType": {
"$ref": "#/components/schemas/UWPBuildTypeType"
},
"msbuildConfiguration": {
"$ref": "#/components/schemas/UWPMSBuildConfigurationType"
},
"platforms": {
"items": {
"$ref": "#/components/schemas/UWPWSAArchitectureType"
},
"type": "array",
"description": "Sets the target platforms for the AppXBundle",
"example": [
"x64",
"x86"
]
},
"publishVisualStudioSolution": {
"type": "boolean",
"description": "Enable publishing of the visual studio .sln file",
"example": true
}
},
"type": "object",
"additionalProperties": false
},
"GamecorescarlettPackageEncryptionType": {
"type": "string",
"enum": [
"development",
"submission"
],
"description": "Gamecorescarlett (Xbox) package encryption type"
},
"GamecorescarlettDeploymentMethodType": {
"type": "string",
"enum": [
"push",
"package"
],
"description": "Gamecorescarlett (Xbox) deployment method"
},
"GamecorescarlettBuildSubtargetType": {
"type": "string",
"enum": [
"development",
"master"
],
"description": "Gamecorescarlett (Xbox) build subtarget type"
},
"Gamecorescarlett": {
"description": "Gamecorescarlett object",
"properties": {
"packageEncryption": {
"$ref": "#/components/schemas/GamecorescarlettPackageEncryptionType"
},
"deploymentMethod": {
"$ref": "#/components/schemas/GamecorescarlettDeploymentMethodType"
},
"buildSubtarget": {
"$ref": "#/components/schemas/GamecorescarlettBuildSubtargetType"
}
},
"type": "object",
"additionalProperties": false
},
"PS5BuildTypeType": {
"type": "string",
"enum": [
"PC Hosted",
"Package",
"GP5 Project"
],
"description": "PlayStation 5 build type"
},
"PS5CompressionTypeType": {
"type": "string",
"enum": [
"Default",
"Kraken"
],
"description": "PlayStation 5 compression type"
},
"Ps5": {
"description": "PS5 build configuration object",
"properties": {
"buildType": {
"$ref": "#/components/schemas/PS5BuildTypeType"
},
"workspaceName": {
"type": "string",
"description": "Which Workspace Name to use for this build",
"example": "workspaceName"
},
"buildCompressionType": {
"$ref": "#/components/schemas/PS5CompressionTypeType"
},
"buildCompressionLevel": {
"type": "integer",
"format": "int64",
"description": "Which Compression Level to use for this build",
"example": 3,
"minimum": -4,
"maximum": 9
},
"sdkVersion": {
"type": "string",
"description": "Which version of the SDK to use for this build",
"example": "sdkVersion"
},
"generateGamePatch": {
"type": "boolean",
"description": "Whether to generate a game patch or not",
"example": true
},
"autoIncrementContentVersion": {
"type": "boolean",
"description": "Whether the content version should be auto incremented or not",
"example": true
}
},
"type": "object",
"additionalProperties": false
},
"Dlc": {
"description": "DLC configuration",
"properties": {
"name": {
"type": "string",
"nullable": true,
"example": "dlcName"
},
"configFile": {
"type": "string",
"nullable": true,
"example": "dlcConfig.json"
}
},
"type": "object",
"additionalProperties": false
},
"BuildTargetAdvancedSettings": {
"description": "Advanced object",
"properties": {
"cache": {
"$ref": "#/components/schemas/Cache"
},
"xcode": {
"$ref": "#/components/schemas/Xcode"
},
"android": {
"$ref": "#/components/schemas/Android"
},
"unity": {
"$ref": "#/components/schemas/Unity"
},
"uwp": {
"$ref": "#/components/schemas/Uwp"
},
"gamecorescarlett": {
"$ref": "#/components/schemas/Gamecorescarlett"
},
"ps5": {
"$ref": "#/components/schemas/Ps5"
},
"generateGamePatch": {
"type": "boolean",
"description": "Whether to generate a game patch or not",
"example": true
},
"autoIncrementBuildVersion": {
"type": "boolean",
"description": "Whether to automatically increment the build version or not",
"example": true
},
"generateDlc": {
"type": "boolean",
"description": "Whether to generate a DLC or not",
"example": true
},
"dlcs": {
"items": {
"$ref": "#/components/schemas/Dlc"
},
"type": "array",
"description": "DLC config"
}
},
"type": "object",
"additionalProperties": false
},
"PlatformConfig": {
"description": "Platform configuration object",
"properties": {
"bundleId": {
"type": "string",
"description": "a unique identifier (com.example.name)",
"example": "bundleId"
},
"xcodeVersion": {
"type": "string",
"description": "a supported xcode version (ex. 'xcode13_0_0')",
"example": "xcodeVersion"
}
},
"type": "object",
"additionalProperties": false
},
"RepeatCycle": {
"type": "string",
"enum": [
"none",
"once",
"daily",
"weekly",
"monthly",
"yearly",
"cron"
],
"default": "once",
"description": "Repeat cycle for scheduled builds"
},
"BuildSchedule": {
"properties": {
"isEnabled": {
"type": "boolean",
"example": false
},
"date": {
"type": "string",
"format": "date-time",
"example": "2000-01-23T04:56:07.000+00:00"
},
"repeatCycle": {
"$ref": "#/components/schemas/RepeatCycle"
},
"cronScheduleString": {
"type": "string",
"description": "cron schedule in string format (* * * * *)",
"example": "cronScheduleString"
},
"cronScheduleTimezone": {
"type": "string",
"description": "cron schedule timezone (default UTC)",
"example": "cronScheduleTimezone"
},
"cleanBuild": {
"type": "boolean",
"example": false
},
"skipBuildIfSameCommit": {
"type": "boolean",
"example": true
}
},
"type": "object",
"additionalProperties": false
},
"BuildTargetWindowsGitBinary": {
"type": "string",
"enum": [
"cygwin",
"native",
"inherit"
],
"default": "inherit",
"description": "Build target Windows Git binary type, including inherit option"
},
"BuildTargetCompressionLevel": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"none",
"inherit"
],
"default": "inherit",
"description": "Build target compression level, including inherit option"
},
"BuildTargetSettings": {
"description": "Settings object",
"properties": {
"autoBuildLatest": {
"allOf": [
{
"$ref": "#/components/schemas/AutoBuildLatestOption"
}
],
"nullable": true,
"description": "start build automatically when using a linked Unity version (ex. Always Use Latest 6000.X) and the linked version is updated",
"example": "inherit"
},
"autoBuild": {
"type": "boolean",
"description": "start builds automatically when your repo is updated",
"example": true
},
"unityVersion": {
"type": "string",
"nullable": true,
"description": "'latest' or a unity dot version with underscores (ex. '4_6_5')",
"example": "2022.3.0f1"
},
"autoDetectUnityVersion": {
"type": "boolean",
"description": "attempt to automatically detect which unity version to use, fallback to specified unityVersion if unable to.",
"example": true
},
"fallbackPatchVersion": {
"type": "boolean",
"description": "attempt to get a similar unity patch version to use, applies to unavailable auto-detected Unity versions only.",
"example": true
},
"ccdEnabled": {
"type": "boolean",
"description": "Enable Content Delivery Service to upload addressables.\n\nIf enabled, `ccdBucketId` and `ccdApiKey` become required.",
"example": true
},
"ccdBucketId": {
"type": "string",
"nullable": true,
"description": "content delivery's bucket to upload addressables to.",
"example": "my-bucket-name"
},
"ccdEnvironmentId": {
"type": "string",
"nullable": true,
"description": "content delivery's environment to upload addressables to.",
"example": "production"
},
"ccdApiKey": {
"type": "string",
"nullable": true,
"description": "content delivery's Api Key.",
"example": "api-key-12345"
},
"ccdStripRemotePath": {
"type": "boolean",
"description": "remove the remote build path from beginning of all addressable paths so bundles are uploaded to bucket root",
"example": true
},
"ccdPreserveBucket": {
"type": "boolean",
"description": "enable contents to stay in bucket after subsequent builds.",
"example": true
},
"ccdCreateRelease": {
"type": "boolean",
"description": "enable automatic release creation from content delivery's bucket.",
"example": true
},
"executablename": {
"type": "string",
"example": "MyApp"
},
"buildProfilePath": {
"type": "string",
"nullable": true,
"example": "~/buildprofiles/buildprofile.json"
},
"scm": {
"$ref": "#/components/schemas/Scm"
},
"platform": {
"$ref": "#/components/schemas/PlatformConfig"
},
"buildSchedule": {
"$ref": "#/components/schemas/BuildSchedule"
},
"autoBuildCancellation": {
"type": "boolean",
"example": false
},
"machineTypeLabel": {
"type": "string",
"nullable": true,
"example": "Standard_v1"
},
"operatingSystemSelected": {
"$ref": "#/components/schemas/OperatingSystem"
},
"operatingSystemVersion": {
"type": "string",
"nullable": true,
"description": "Choose the version of the operating system for building your project.",
"example": "sonomaSilicon"
},
"rubyVersion": {
"type": "string",
"nullable": true,
"example": "3.2.0"
},
"remoteCacheStrategy": {
"allOf": [
{
"$ref": "#/components/schemas/CacheStrategy"
}
],
"nullable": true,
"description": "Specifies the caching strategy (none, library, workspace, or inherit) for remote data storage and retrieval",
"example": "none"
},
"windowsGitBinary": {
"allOf": [
{
"$ref": "#/components/schemas/BuildTargetWindowsGitBinary"
}
],
"nullable": true,
"description": "Specifies the Git binary that will be used for Windows builds",
"example": "inherit"
},
"buildTargetCopyCache": {
"type": "string",
"nullable": true,
"description": "Specifies the id of the build target that this target's cache was copied from",
"example": "enabled"
},
"architecture": {
"type": "string",
"nullable": true,
"description": "Specifies the Unity editor architecture to use for building the project.",
"example": "x86_64"
},
"cacheCompressionLevel": {
"allOf": [
{
"$ref": "#/components/schemas/BuildTargetCompressionLevel"
}
],
"nullable": true,
"description": "Specifies the compression level for caching workspace or Library.",
"example": "inherit"
},
"artifactCompressionLevel": {
"allOf": [
{
"$ref": "#/components/schemas/BuildTargetCompressionLevel"
}
],
"nullable": true,
"description": "Specifies the compression level for compressed final artifacts.",
"example": "inherit"
},
"ignorePlasticCheckedInLibrary": {
"type": "boolean",
"description": "Ignore the checked-in Library folder when building from Plastic SCM.",
"example": true
},
"advanced": {
"$ref": "#/components/schemas/BuildTargetAdvancedSettings"
}
},
"type": "object",
"additionalProperties": false
},
"BuildTarget": {
"description": "Build target information",
"properties": {
"connectionId": {
"$ref": "#/components/schemas/UUID"
},
"buildTargetId": {
"type": "string",
"example": "buildTargetId"
},
"name": {
"type": "string",
"example": "John Doe"
},
"enabled": {
"type": "boolean",
"example": true
},
"platform": {
"$ref": "#/components/schemas/Platform"
},
"builderOperatingSystem": {
"$ref": "#/components/schemas/OperatingSystem"
}
},
"type": "object",
"additionalProperties": false
},
"BuildTargetGroup": {
"description": "Build target group",
"properties": {
"id": {
"type": "string",
"example": "id"
},
"name": {
"type": "string",
"example": "John Doe"
},
"description": {
"type": "string",
"example": "description"
},
"created": {
"type": "string",
"format": "date-time",
"example": "2000-01-23T04:56:07.000+00:00"
},
"lastModified": {
"type": "string",
"format": "date-time",
"example": "2000-01-23T04:56:07.000+00:00"
},
"deleted": {
"type": "boolean",
"example": false
},
"enabled": {
"type": "boolean",
"example": true
},
"buildTargets": {
"items": {
"$ref": "#/components/schemas/BuildTarget"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"LastBuilt": {
"description": "LastBuilt object",
"properties": {
"unityVersion": {
"type": "string",
"description": "Last Unity version built by this target. Setting this has no effect.",
"example": "2022.3.0f1"
}
},
"type": "object",
"additionalProperties": false
},
"BuildTargetNoticeCode": {
"type": "string",
"enum": [
"unity_version_deprecated",
"unity_version_security_vulnerability",
"xcode_version_deprecated",
"operating_system_version_deprecated"
]
},
"BuildTargetNoticeSeverity": {
"type": "string",
"enum": [
"warning",
"critical"
]
},
"BuildTargetNoticeSubject": {
"type": "string",
"enum": [
"unityVersion",
"xcodeVersion",
"operatingSystemVersion"
]
},
"BuildTargetNotice": {
"description": "A single problem with one of a build target's configured tooling versions.",
"properties": {
"code": {
"$ref": "#/components/schemas/BuildTargetNoticeCode"
},
"severity": {
"$ref": "#/components/schemas/BuildTargetNoticeSeverity"
},
"subject": {
"$ref": "#/components/schemas/BuildTargetNoticeSubject"
},
"value": {
"type": "string",
"description": "The version actually judged, in stored form.",
"example": "2023_2_0f1"
},
"message": {
"type": "string",
"description": "Human-readable description, and the only place the pinned versus last-built distinction appears.",
"example": "Unity version 2023_2_0f1 is deprecated. Upgrade this build target to a supported version."
},
"moreInfoUrl": {
"type": "string",
"description": "Where to read more. Present only on a security vulnerability notice.",
"example": "https://unity.com/security/sept-2025-01/remediation"
}
},
"required": [
"code",
"severity",
"subject",
"value",
"message"
],
"type": "object",
"additionalProperties": false
},
"CredentialResourceRef": {
"description": "CredentialResourceRef object",
"properties": {
"platform": {
"$ref": "#/components/schemas/Platform"
},
"label": {
"type": "string",
"example": "Production Build"
},
"credentialid": {
"type": "string",
"example": "a7dba621-a877-43c5-8163-bda58247124e"
},
"created": {
"type": "string",
"format": "date-time",
"example": "2023-01-01T00:00:00Z"
},
"lastMod": {
"type": "string",
"format": "date-time",
"example": "2023-01-01T00:00:00Z"
},
"certificate": {
"$ref": "#/components/schemas/Certificate"
},
"provisioningProfile": {
"$ref": "#/components/schemas/ProvisioningProfile"
},
"keystore": {
"$ref": "#/components/schemas/Keystore"
},
"links": {
"$ref": "#/components/schemas/CredentialSigningLinks"
}
},
"type": "object",
"additionalProperties": false
},
"Signing": {
"description": "Signing object",
"properties": {
"credentialid": {
"type": "string",
"example": "credential-id-123"
},
"credentialResourceRef": {
"$ref": "#/components/schemas/CredentialResourceRef"
}
},
"type": "object",
"additionalProperties": false
},
"Credentials": {
"description": "Credentials object",
"properties": {
"signing": {
"$ref": "#/components/schemas/Signing"
}
},
"type": "object",
"additionalProperties": false
},
"CanceledByOption": {
"type": "string",
"enum": [
"api",
"service",
"service-badconfiguration",
"service-timelimit",
"job-timelimit",
"billing-invalidsubscription",
"concurrency-timelimit",
"restart-limit",
"evaluation-timelimit",
"jenkins-timelimit"
],
"description": "Reason why a build was canceled"
},
"GitTimestamp": {
"type": "string",
"description": "Git timestamp string (e.g. \"2026-06-05 08:35:56 +0000\")",
"pattern": "\\d{4}-\\d{2}-\\d{2}\\s\\d{2}:\\d{2}:\\d{2}\\s[+-]\\d{4}"
},
"ChangesetAuthor": {
"description": "Author block stored on each build attempt changeset entry (see IChangeSetDocument).",
"properties": {
"absoluteUrl": {
"type": "string",
"nullable": true
},
"fullName": {
"type": "string",
"nullable": true
}
},
"type": "object",
"additionalProperties": false
},
"ChangesetItem": {
"description": "Single changeset entry: persisted build-attempt shape and optional legacy file/action fields.",
"properties": {
"file": {
"type": "string",
"description": "Legacy per-file entries (some clients still send this on checkout status).",
"example": "test.cs"
},
"action": {
"type": "string",
"example": "modified"
},
"numAffectedFiles": {
"type": "integer",
"format": "int64",
"example": 3
},
"commitId": {
"type": "string",
"example": "abc123def456"
},
"timestamp": {
"anyOf": [
{
"$ref": "#/components/schemas/GitTimestamp"
},
{
"type": "string",
"format": "date-time"
}
],
"description": "SCM-provided commit time.",
"example": "2026-06-05 08:35:56 +0000"
},
"author": {
"$ref": "#/components/schemas/ChangesetAuthor"
},
"message": {
"type": "string",
"nullable": true
}
},
"type": "object",
"additionalProperties": false
},
"QueuedReasonOption": {
"type": "string",
"enum": [
"sentToBuilder",
"targetConcurrency",
"concurrency",
"projectPreviewConcurrency",
"cooldown",
"buildConcurrency",
"waitingForBuildAgent",
"evaluating",
"notPending"
],
"description": "Reason why a build is queued"
},
"ProjectVersion": {
"description": "ProjectVersion object",
"properties": {
"name": {
"type": "string",
"description": "automatically generated name for the build",
"example": "John Doe"
},
"filename": {
"type": "string",
"description": "filename for the primary artifact",
"example": "filename"
},
"projectName": {
"type": "string",
"description": "name of the project",
"example": "projectName"
},
"platform": {
"$ref": "#/components/schemas/Platform"
},
"size": {
"type": "integer",
"format": "int64",
"description": "size of the the primary build artifact in bytes",
"example": 1048576,
"minimum": 0
},
"created": {
"type": "string",
"format": "date-time",
"description": "creation date",
"example": "2023-01-01T00:00:00Z"
},
"lastMod": {
"type": "string",
"format": "date-time",
"description": "last modified date",
"example": "2023-01-01T00:00:00Z"
},
"bundleId": {
"type": "string",
"description": "a unique identifier (com.example.name)",
"example": "bundleId"
},
"udids": {
"items": {
"type": "string"
},
"type": "array",
"description": "iPhone unique identifiers that are able to install this build",
"example": [
"device1",
"device2"
]
},
"links": {
"$ref": "#/components/schemas/Record_string.Link_"
}
},
"type": "object",
"additionalProperties": false
},
"ArtifactFileResponse": {
"description": "Artifact file response with download link",
"properties": {
"filename": {
"type": "string",
"example": "build.apk"
},
"size": {
"type": "integer",
"format": "int64",
"example": 1024000,
"minimum": 0
},
"resumable": {
"type": "boolean",
"example": false
},
"md5sum": {
"type": "string",
"example": "abc123def456"
},
"href": {
"type": "string",
"description": "Download URL for this file. May be either an absolute URL (e.g. a signed storage URL that can be requested directly) or a path relative to this API (which must be resolved against the host you used to make the original request).",
"example": "https://storage.googleapis.com/bucket/path/to/file"
},
"redirect": {
"type": "boolean",
"description": "When `true`, `href` points back at this API rather than directly at a storage backend.\n\nFollowing an internal `href` returns a `303 See Other` whose body is the signed storage URL as a JSON string. The response does **not** set a `Location` header, so standard redirect-following (e.g. `curl -L`, browser fetch with default settings, HTTP libraries with redirects enabled) will *not* follow it. To consume the link, clients must parse the URL from the body and `GET` it directly.",
"example": false
}
},
"required": [
"filename"
],
"type": "object",
"additionalProperties": false
},
"ArtifactResponse": {
"description": "Artifact link with associated files",
"properties": {
"key": {
"type": "string",
"example": "primary"
},
"name": {
"type": "string",
"example": "Primary Build"
},
"primary": {
"type": "boolean",
"example": true
},
"show_download": {
"type": "boolean",
"example": true
},
"webgl_template": {
"type": "string",
"example": "APPLICATION:Default"
},
"files": {
"items": {
"$ref": "#/components/schemas/ArtifactFileResponse"
},
"type": "array"
},
"extractedArchiveLocation": {
"type": "string",
"example": "/share/example-org/new-project/android-builder-1/extracted"
}
},
"required": [
"key",
"name",
"primary",
"show_download",
"files"
],
"type": "object",
"additionalProperties": false
},
"BuildReportLink": {
"description": "A hypermedia link to a single build report file (e.g. `editor.log`, `Player.log`, build report XML).\n\nProduced by `generateBuildReportLinks` and exposed under `BuildArtifactsLinks.buildReports`, keyed by the file's basename. Distinct from {@link Link } because every entry carries the originating filename so clients can render a label without parsing the href.",
"properties": {
"method": {
"$ref": "#/components/schemas/HttpMethod"
},
"href": {
"type": "string",
"description": "Signed download URL for the report file.",
"example": "https://example.com/builds/1/reports/editor.log?signature=..."
},
"filename": {
"type": "string",
"description": "Original filename of the report (e.g. `editor.log`). Mirrors the key under which this entry is stored in `BuildArtifactsLinks.buildReports`.",
"example": "editor.log"
}
},
"required": [
"href",
"filename"
],
"type": "object",
"additionalProperties": false
},
"Record_string.BuildReportLink_": {
"properties": {},
"additionalProperties": {
"$ref": "#/components/schemas/BuildReportLink"
},
"type": "object",
"description": "Construct a type with a set of properties K of type T"
},
"BuildArtifactsLinks": {
"description": "Hypermedia links attached to a build attempt.",
"properties": {
"self": {
"$ref": "#/components/schemas/Link"
},
"log": {
"$ref": "#/components/schemas/Link"
},
"auditlog": {
"$ref": "#/components/schemas/Link"
},
"cancel": {
"$ref": "#/components/schemas/Link"
},
"create_share": {
"$ref": "#/components/schemas/Link"
},
"revoke_share": {
"$ref": "#/components/schemas/Link"
},
"icon": {
"$ref": "#/components/schemas/Link"
},
"download_primary": {
"$ref": "#/components/schemas/Link"
},
"download_dsym": {
"$ref": "#/components/schemas/Link"
},
"artifacts": {
"items": {
"$ref": "#/components/schemas/ArtifactResponse"
},
"type": "array",
"description": "All build artifacts (archives + their files) attached to this build.\n\nAlways present; may be an empty array. The shape mirrors v1's `download.generateAllArtifacts` output — each entry carries the archive `key`/`name`/`primary`/`show_download`/`webgl_template` flags plus the per-file signed download URLs under `files`."
},
"buildReports": {
"$ref": "#/components/schemas/Record_string.BuildReportLink_"
}
},
"type": "object",
"additionalProperties": false
},
"BuildReport": {
"description": "BuildReport object",
"properties": {
"errors": {
"type": "integer",
"format": "int64",
"example": 7,
"minimum": 0
},
"warnings": {
"type": "integer",
"format": "int64",
"example": 1,
"minimum": 0
}
},
"type": "object",
"additionalProperties": false
},
"TestResult": {
"description": "Individual test result",
"properties": {
"passed": {
"type": "integer",
"format": "int64",
"example": 10,
"minimum": 0
},
"failed": {
"type": "integer",
"format": "int64",
"example": 2,
"minimum": 0
},
"duration": {
"type": "number",
"format": "double",
"example": 120.5
}
},
"required": [
"passed",
"failed"
],
"type": "object",
"additionalProperties": false
},
"TestResults": {
"description": "results from the build's unit tests, if any",
"properties": {
"unit_test": {
"$ref": "#/components/schemas/TestResult"
},
"unit_test_editmode": {
"$ref": "#/components/schemas/TestResult"
},
"unit_test_playmode": {
"$ref": "#/components/schemas/TestResult"
}
},
"type": "object",
"additionalProperties": false
},
"CustomConfig": {
"description": "additional configuration for entitled platforms from the build target",
"properties": {
"unity": {
"$ref": "#/components/schemas/Unity"
},
"generateGamePatch": {
"type": "boolean",
"description": "Whether to generate a game patch or not",
"example": true
},
"ps5": {
"$ref": "#/components/schemas/Ps5"
}
},
"type": "object",
"additionalProperties": false
},
"Config": {
"description": "additional configuration for entitled platforms",
"properties": {
"referenceBuildAttempt": {
"type": "boolean",
"example": true
},
"latestPatchBuildAttempt": {
"type": "boolean",
"example": true
},
"buildVersion": {
"type": "string",
"nullable": true,
"example": "buildVersion"
},
"displayVersion": {
"type": "string",
"nullable": true,
"example": "displayVersion"
},
"ps5": {
"$ref": "#/components/schemas/Ps5"
}
},
"type": "object",
"additionalProperties": false
},
"SignedUrlCredential": {
"description": "Signed URL credential for uploading one file.",
"properties": {
"SignedUrl": {
"type": "string",
"example": "https://example.com/signed-url"
},
"ResumableUri": {
"type": "string",
"example": "https://example.com/resumable-upload"
}
},
"type": "object",
"additionalProperties": false
},
"Record_string.SignedUrlCredential_": {
"properties": {},
"additionalProperties": {
"$ref": "#/components/schemas/SignedUrlCredential"
},
"type": "object",
"description": "Construct a type with a set of properties K of type T"
},
"GetBuildResponse": {
"description": "buildattempt",
"properties": {
"build": {
"type": "integer",
"format": "int64",
"example": 42,
"minimum": 0
},
"buildtargetid": {
"type": "string",
"description": "unique id auto-generated from the build target name",
"example": "ios"
},
"buildTargetName": {
"type": "string",
"example": "Build Target Name"
},
"buildGUID": {
"type": "string",
"description": "unique GUID identifying this build",
"example": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
},
"buildStatus": {
"$ref": "#/components/schemas/BuildStatus"
},
"cleanBuild": {
"type": "boolean",
"description": "if the build was built without using data cached from previous builds",
"example": true
},
"scenePreview": {
"type": "boolean",
"description": "Whether this build attempt is a scene-preview build.",
"example": false
},
"failureDetails": {
"items": {
"$ref": "#/components/schemas/BuildFailureItem"
},
"type": "array",
"description": "list of failure details for this build attempt, when available"
},
"canceledBy": {
"$ref": "#/components/schemas/CanceledByOption"
},
"causedBy": {
"type": "string",
"description": "What triggered the build to be created",
"example": "api"
},
"causedByUser": {
"type": "string",
"description": "Name of the user who caused the build to be created",
"example": "John Doe"
},
"causedByServiceAccountId": {
"type": "string",
"description": "UUID of the service account that triggered the build (set instead of causedByUser when a v2 gateway service account started it)",
"example": "1c4c5981-3aea-4c0a-aec7-47205886a098"
},
"buildProfilePath": {
"type": "string",
"example": "~/buildprofiles/buildprofile.json"
},
"platform": {
"$ref": "#/components/schemas/Platform"
},
"formattedPlatformName": {
"type": "string",
"example": "iOS"
},
"editorIcon": {
"type": "string",
"example": "ios_editor_icon.png"
},
"workspaceSize": {
"type": "integer",
"format": "int64",
"description": "size of workspace in bytes",
"example": 1048576,
"minimum": 0
},
"created": {
"type": "string",
"format": "date-time",
"description": "when the build was created",
"example": "2025-11-08T12:00:00Z"
},
"finished": {
"type": "string",
"format": "date-time",
"description": "when the build completely finished",
"example": "2025-11-08T12:00:00Z"
},
"checkoutStartTime": {
"type": "string",
"format": "date-time",
"description": "when the build starting checking out code",
"example": "2025-11-08T12:00:00Z"
},
"checkoutTimeInSeconds": {
"type": "number",
"format": "double",
"description": "amount of time spent checking out code",
"example": 120,
"minimum": 0
},
"buildStartTime": {
"type": "string",
"format": "date-time",
"description": "when the build started compiling",
"example": "2025-11-08T12:00:00Z"
},
"buildTimeInSeconds": {
"type": "number",
"format": "double",
"description": "amount of time spend compiling",
"example": 300,
"minimum": 0
},
"buildTimeoutMinutes": {
"type": "integer",
"format": "int64",
"description": "total allowed build time before the build attempt times out",
"minimum": 0
},
"publishStartTime": {
"type": "string",
"format": "date-time",
"description": "when the build started saving build artifacts",
"example": "2025-11-08T12:00:00Z"
},
"publishTimeInSeconds": {
"type": "number",
"format": "double",
"description": "amount of time spent saving build artifacts",
"example": 60,
"minimum": 0
},
"totalTimeInSeconds": {
"type": "number",
"format": "double",
"description": "total time for the build",
"example": 600,
"minimum": 0
},
"billableTimeInSeconds": {
"type": "number",
"format": "double",
"description": "total billable time for the build",
"example": 580,
"minimum": 0
},
"unitTestTimeInSeconds": {
"type": "number",
"format": "double",
"description": "total time for unit test execution step",
"example": 90,
"minimum": 0
},
"editModeTestTimeInSeconds": {
"type": "number",
"format": "double",
"description": "total time for unit test execution step",
"example": 30,
"minimum": 0
},
"playModeTestTimeInSeconds": {
"type": "number",
"format": "double",
"description": "total time for unit test execution step",
"example": 45,
"minimum": 0
},
"lastBuiltRevision": {
"type": "string",
"description": "source control commit id for the build",
"example": "abc123def456"
},
"changeset": {
"items": {
"$ref": "#/components/schemas/ChangesetItem"
},
"type": "array",
"description": "a list of source control changes between this and the last build"
},
"favorited": {
"type": "boolean",
"description": "if the build is marked as do not delete or not",
"example": true
},
"label": {
"type": "string",
"description": "description given when a build is favorited",
"example": "Production Build"
},
"deleted": {
"type": "boolean",
"description": "if the build is deleted or not",
"example": true
},
"deletedArtifacts": {
"type": "boolean",
"description": "true once the build's artifacts have been deleted",
"example": true
},
"deletedLogs": {
"type": "boolean",
"description": "true once the build's logs have been deleted",
"example": true
},
"deletedDate": {
"type": "string",
"format": "date-time",
"description": "time at which the build was deleted",
"example": "2025-11-08T12:00:00Z"
},
"headless": {
"type": "boolean",
"description": "if the build was built to run in linux headless mode",
"example": true
},
"credentialsOutdated": {
"type": "boolean",
"description": "if a newer credential has been attached to this buildtarget and the build can be re-signed",
"example": true
},
"groupBuildId": {
"type": "string",
"description": "the unique ID used to launch a group of attempts",
"example": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
},
"buildTargetGroups": {
"items": {
"$ref": "#/components/schemas/BuildTargetGroup"
},
"type": "array",
"description": "list of build target groups this build attempt is a part of"
},
"machineType": {
"$ref": "#/components/schemas/MachineType"
},
"deletedBy": {
"type": "string",
"description": "email address of the user who deleted this attempt",
"example": "user@example.com"
},
"deletedByRetentionPolicy": {
"type": "string",
"description": "GUID of the retention policy that deleted this attempt, when it was removed by retention rather than a user",
"example": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
},
"queuedReason": {
"$ref": "#/components/schemas/QueuedReasonOption"
},
"cooldownDate": {
"type": "string",
"format": "date-time",
"description": "time until this build will be reconsidered for building",
"example": "2025-11-08T12:00:00Z"
},
"scmBranch": {
"type": "string",
"description": "scm branch to be built",
"example": "main"
},
"unityVersion": {
"type": "string",
"description": "'latest' or a unity dot version with underscores (ex. '4_6_5')",
"example": "2022.3.0f1"
},
"localUnityVersion": {
"type": "string",
"description": "The version of Unity detected from ProjectVersion.txt",
"example": "2022.3.0f1"
},
"architecture": {
"type": "string",
"description": "The Unity editor architecture used for building",
"example": "AppleIntel"
},
"operatingSystemVersion": {
"type": "string",
"description": "a supported operating system version (ex. 'monterey')",
"example": "monterey"
},
"operatingSystem": {
"type": "string",
"description": "the OS that this build ran (or will run) on (ex. 'windows' / 'mac')",
"example": "mac"
},
"xcodeVersion": {
"type": "string",
"description": "a supported xcode version (ex. 'xcode13_0_0')",
"example": "xcode13_0_0"
},
"androidSdkVersion": {
"type": "string",
"description": "a supported android sdk version (ex. 'android_sdk_34')",
"example": "android_sdk_34"
},
"auditChanges": {
"type": "integer",
"format": "int64",
"example": 3,
"minimum": 0
},
"projectVersion": {
"$ref": "#/components/schemas/ProjectVersion"
},
"projectName": {
"type": "string",
"example": "Project Name"
},
"projectId": {
"type": "string",
"example": "1234567890"
},
"projectGuid": {
"type": "string",
"example": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
},
"orgId": {
"type": "string",
"example": "046b6c7f-0b8a-43b9-0000-6489e6daee91"
},
"orgFk": {
"type": "string",
"example": "1234567890"
},
"filetoken": {
"type": "string",
"example": "1234567890"
},
"links": {
"$ref": "#/components/schemas/BuildArtifactsLinks"
},
"buildReport": {
"$ref": "#/components/schemas/BuildReport"
},
"testResults": {
"$ref": "#/components/schemas/TestResults"
},
"machineTypeLabel": {
"type": "string",
"example": "Machine Type Label"
},
"requestedRevision": {
"type": "string",
"example": "1234567890"
},
"error": {
"type": "string",
"example": "error"
},
"customConfig": {
"$ref": "#/components/schemas/CustomConfig"
},
"config": {
"$ref": "#/components/schemas/Config"
},
"signedUrls": {
"$ref": "#/components/schemas/Record_string.SignedUrlCredential_"
}
},
"required": [
"build",
"buildtargetid",
"buildStatus",
"platform"
],
"type": "object",
"additionalProperties": false
},
"AddBuildTargetResponse": {
"description": "Response for addBuildTarget",
"properties": {
"connectionId": {
"$ref": "#/components/schemas/UUID"
},
"guid": {
"type": "string",
"description": "globally unique id for the build target"
},
"name": {
"type": "string",
"example": "John Doe"
},
"createdBy": {
"type": "string",
"example": "user@example.com"
},
"platform": {
"$ref": "#/components/schemas/Platform"
},
"targetType": {
"$ref": "#/components/schemas/TargetType"
},
"buildtargetid": {
"type": "string",
"description": "unique id auto-generated from the build target name",
"example": "ios"
},
"enabled": {
"type": "boolean",
"description": "whether this target can be built by the API",
"example": true
},
"generateProjectPreview3D": {
"type": "boolean",
"description": "When the target's targetType is projectPreview, emit a 3D preview alongside the standard preview.",
"example": false
},
"scenePreview": {
"type": "boolean",
"description": "Whether this build target is flagged as a scene-preview build target.",
"example": false
},
"settings": {
"$ref": "#/components/schemas/BuildTargetSettings"
},
"buildTargetGroups": {
"items": {
"$ref": "#/components/schemas/BuildTargetGroup"
},
"type": "array"
},
"lastBuilt": {
"$ref": "#/components/schemas/LastBuilt"
},
"notices": {
"items": {
"$ref": "#/components/schemas/BuildTargetNotice"
},
"type": "array",
"description": "Problems with the tooling versions this target is configured to build with. Empty means there are no known notices. Tooling whose version could not be resolved, such as the Unity version of an auto-detect target that has never built, contributes no notice."
},
"credentials": {
"$ref": "#/components/schemas/Credentials"
},
"builds": {
"items": {
"$ref": "#/components/schemas/GetBuildResponse"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/Record_string.Link_"
}
},
"required": [
"name",
"platform",
"buildtargetid",
"enabled"
],
"type": "object",
"additionalProperties": false
},
"CreatedByOption": {
"type": "string",
"enum": [
"editor",
"api",
"ui"
],
"default": "api",
"description": "Source that created a build"
},
"AddBuildTargetRequestBody": {
"description": "Request body for addBuildTarget",
"properties": {
"connectionId": {
"$ref": "#/components/schemas/UUID"
},
"name": {
"type": "string",
"example": "My Build Target"
},
"createdBy": {
"allOf": [
{
"$ref": "#/components/schemas/CreatedByOption"
}
],
"nullable": true,
"example": "editor"
},
"platform": {
"$ref": "#/components/schemas/Platform"
},
"targetType": {
"$ref": "#/components/schemas/TargetType"
},
"enabled": {
"type": "boolean",
"example": true
},
"generateProjectPreview3D": {
"type": "boolean",
"description": "When the target's targetType is projectPreview, emit a 3D preview alongside the standard preview.",
"example": false
},
"scenePreview": {
"type": "boolean",
"description": "Flag this build target as a scene-preview build target. Only settable by orgs enrolled in Unity Pipeline; other orgs are rejected with 403.",
"example": false
},
"settings": {
"$ref": "#/components/schemas/BuildTargetSettings"
},
"credentials": {
"$ref": "#/components/schemas/Credentials"
}
},
"type": "object",
"additionalProperties": false
},
"GetStatsForBuildTargetResponse": {
"description": "Response for getStatsForBuildTarget",
"properties": {
"totalBuilds": {
"type": "integer",
"format": "int64",
"example": 100,
"minimum": 0
},
"successfulBuilds": {
"type": "integer",
"format": "int64",
"example": 80,
"minimum": 0
},
"canceledBuilds": {
"type": "integer",
"format": "int64",
"example": 5,
"minimum": 0
},
"failedBuilds": {
"type": "integer",
"format": "int64",
"example": 15,
"minimum": 0
},
"averageWorkspaceSize": {
"type": "number",
"format": "double",
"example": 5.637376656633329
},
"averageTotalTime": {
"type": "number",
"format": "double",
"example": 2.3021358869347655
},
"averageWaitTime": {
"type": "number",
"format": "double",
"example": 7.061401241503109
},
"averageCheckoutTime": {
"type": "number",
"format": "double",
"example": 9.301444243932576
},
"averageBuildTime": {
"type": "number",
"format": "double",
"example": 3.616076749251911
},
"averagePublishTime": {
"type": "number",
"format": "double",
"example": 2.027123023002322
}
},
"type": "object",
"additionalProperties": false
},
"MachineTypeSKULabel": {
"type": "string",
"enum": [
"win_premium_v1",
"win_standard_v1",
"mac_standard_v1",
"mac_premium_v1"
],
"description": "Machine type SKU label for build overrides. - win_premium_v1: Windows premium machine type - win_standard_v1: Windows standard machine type - mac_standard_v1: macOS standard machine type - mac_premium_v1: macOS premium machine type"
},
"LocalBuildFile": {
"description": "A file the client will directly upload for a local build. `key` is the storage key (filename) and `contentType` its MIME type; `resumable` opts into a resumable upload URL (GCS).",
"properties": {
"key": {
"type": "string",
"example": "webgl-good.zip"
},
"contentType": {
"type": "string",
"example": "application/zip"
},
"resumable": {
"type": "boolean",
"example": true
}
},
"required": [
"key",
"contentType"
],
"type": "object",
"additionalProperties": false
},
"StartBuildsRequestBody": {
"description": "Request body for startBuilds",
"properties": {
"clean": {
"type": "boolean"
},
"delay": {
"type": "integer",
"format": "int64",
"description": "Delay to start build, in milliseconds",
"minimum": 0
},
"commit": {
"type": "string"
},
"branch": {
"type": "string",
"description": "Optional override for the default branch"
},
"headless": {
"type": "boolean",
"description": "Only valid for local builds"
},
"label": {
"type": "string",
"description": "Only valid for local builds"
},
"platform": {
"$ref": "#/components/schemas/Platform"
},
"scenePreview": {
"type": "boolean",
"description": "Only valid for local builds. Flag this build as a scene-preview build. Requires the org to be enrolled in Unity Pipeline (else 403) and the platform to be webgl (else 422)."
},
"buildtargetsettings": {},
"causedBy": {
"type": "string"
},
"envvars": {},
"provider": {
"type": "string",
"description": "Optional override for the default provider set for automated regression testing"
},
"cloudProviderOverride": {
"type": "string",
"description": "Optional override for the default provider set for smoke testing"
},
"targetTypeOverride": {
"$ref": "#/components/schemas/TargetType"
},
"region": {
"type": "string",
"description": "Optional override for the default region"
},
"zone": {
"type": "string",
"description": "Optional override for the default zone"
},
"operatingSystemSelected": {
"type": "string",
"description": "Optional operating system family for the build"
},
"operatingSystemVersion": {
"type": "string",
"description": "Optional operating system version for the build"
},
"imageOverride": {
"type": "string",
"description": "Optional image override for the build"
},
"regionOverride": {
"type": "string",
"description": "Optional region override for the build"
},
"zoneOverride": {
"type": "string",
"description": "Optional zone override for the build"
},
"unityVersion": {
"type": "string",
"description": "Optional Unity version override for the build"
},
"xcodeVersion": {
"type": "string",
"description": "Optional Xcode version override for the build"
},
"buildTargetGroupIds": {
"items": {
"type": "string"
},
"type": "array",
"description": "Optional group ids for build. Must correspond to existing BuildTargetGroup id. groupBuildId field is required if buildTargetGroupId is set."
},
"groupBuildId": {
"type": "string",
"description": "Optional group build id for build. Must be unique id within the group. buildTargetGroupIds field is required if groupBuildId is set."
},
"machineTypeLabel": {
"$ref": "#/components/schemas/MachineTypeSKULabel"
},
"architecture": {
"type": "string",
"description": "Optional editor architecture override for the build."
},
"shelvesetID": {
"type": "string",
"description": "Optional shelf changeset used for UVCS shelve and build operations"
},
"androidSDKVersion": {
"type": "string",
"description": "Android SDK Version"
},
"files": {
"items": {
"$ref": "#/components/schemas/LocalBuildFile"
},
"type": "array",
"description": "Optional files for direct upload (local builds only). Each entry is a {@link LocalBuildFile} carrying a storage key (filename) and contentType."
},
"repo": {
"type": "string",
"description": "Optional UVCS repo override for the build"
}
},
"type": "object",
"additionalProperties": false
},
"CreateBuildTargetGroupResponse": {
"description": "Response for createBuildTargetGroup",
"properties": {
"id": {
"type": "string",
"example": "id"
},
"name": {
"type": "string",
"example": "John Doe"
},
"description": {
"type": "string",
"example": "description"
},
"created": {
"type": "string",
"format": "date-time",
"example": "2000-01-23T04:56:07.000+00:00"
},
"lastModified": {
"type": "string",
"format": "date-time",
"example": "2000-01-23T04:56:07.000+00:00"
},
"deleted": {
"type": "boolean",
"example": true
},
"enabled": {
"type": "boolean",
"example": true
},
"buildTargets": {
"items": {
"$ref": "#/components/schemas/BuildTarget"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"CreateBuildTargetGroupRequestBody": {
"description": "Request body for createBuildTargetGroup",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"buildTargetIds": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name",
"buildTargetIds"
],
"type": "object",
"additionalProperties": false
},
"DeleteBuildTargetGroupsRequestBody": {
"description": "Request body for deleteBuildTargetGroups",
"properties": {
"buildTargetGroupIds": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"buildTargetGroupIds"
],
"type": "object",
"additionalProperties": false
},
"GetBuildTargetGroupsResponse": {
"description": "Response for getBuildTargetGroups",
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/BuildTargetGroup"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"UpdateBuildTargetGroupRequestBody": {
"description": "Request body for updateBuildTargetGroup",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"buildTargetIds": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"UpdateBuildTargetGroupEnabledRequestBody": {
"description": "Request body for updateBuildTargetGroupEnabled",
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object",
"additionalProperties": false
},
"UpdateBuildTargetGroupsEnabledRequestBody": {
"description": "Request body for updateBuildTargetGroupsEnabled",
"properties": {
"buildTargetGroupIds": {
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"buildTargetGroupIds",
"enabled"
],
"type": "object",
"additionalProperties": false
},
"BuildNumber": {
"anyOf": [
{
"$ref": "#/components/schemas/PositiveInteger"
},
{
"$ref": "#/components/schemas/UUID"
},
{
"type": "string",
"enum": [
"_all"
]
}
]
},
"Build": {
"description": "Build information",
"properties": {
"buildtargetid": {
"type": "string",
"example": "ios"
},
"build": {
"type": "integer",
"format": "int64",
"description": "Build attempt count (build number) within the build target.",
"example": 1,
"minimum": 0
}
},
"type": "object",
"additionalProperties": false
},
"BatchCancelBuildsRequestBody": {
"description": "Request body for batchCancelBuilds",
"properties": {
"builds": {
"items": {
"$ref": "#/components/schemas/Build"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"GetShareResponse": {
"description": "Response for getShare",
"properties": {
"shareid": {
"type": "string",
"example": "shareid"
},
"shareExpiry": {
"type": "string",
"format": "date-time",
"example": "2025-12-31T23:59:59.000Z"
}
},
"type": "object",
"additionalProperties": false
},
"CreateShareRequestBody": {
"description": "Request body for createShare",
"properties": {
"shareExpiry": {
"type": "string",
"format": "date-time"
}
},
"type": "object",
"additionalProperties": false
},
"GetBuildLogResponse": {
"description": "Response for getBuildLog",
"properties": {
"redirect_url": {
"type": "string",
"description": "The signed URL to the log file",
"example": "https://example.com/path/to/build/log"
}
},
"type": "object",
"additionalProperties": false
},
"BuildLogRedirectType": {
"type": "string",
"enum": [
"none",
"auto",
"manual"
],
"default": "auto",
"description": "Build log redirect type. - auto: Automatically redirect based on log type - manual: Manual redirect - none: No redirect"
},
"GetFileDownloadUrlResponse": {
"description": "Response body for `getFileDownloadUrl`.\n\nReturned with a `303 See Other` status, but the response carries the signed storage URL in the body — **no `Location` header is set**, so standard redirect-following won't follow it. Clients must read `url` from the body and `GET` it directly.",
"properties": {
"url": {
"type": "string",
"description": "Signed storage URL for the requested build artifact. Issue a `GET` against this URL to retrieve the file.",
"example": "https://storage.googleapis.com/signed-url-to-artifact"
}
},
"required": [
"url"
],
"type": "object",
"additionalProperties": false
},
"BuildStepMessage": {
"description": "Build step message",
"properties": {
"content": {
"type": "string",
"example": "Library/PackageCache/com.unity.analytics@3.2.2/DataPrivacy/DataPrivacyButton.cs(28,13): warning CS0618"
},
"typeCode": {
"type": "integer",
"format": "int64",
"example": 2,
"minimum": 0
}
},
"type": "object",
"additionalProperties": false
},
"BuildStepResponse": {
"description": "Response for getBuildSteps - individual build step",
"properties": {
"depth": {
"type": "integer",
"format": "int64",
"example": 0,
"minimum": 0
},
"duration": {
"type": "number",
"format": "double",
"example": 67138.5108
},
"name": {
"type": "string",
"example": "Build player"
},
"messages": {
"items": {
"$ref": "#/components/schemas/BuildStepMessage"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object",
"additionalProperties": false
},
"UpdateBuildRequestBody": {
"description": "Request body for updateBuild",
"properties": {
"favorited": {
"type": "boolean",
"example": false
},
"label": {
"type": "string",
"example": "Release Build"
},
"buildTimeoutMinutes": {
"type": "integer",
"format": "int64",
"description": "total allowed build time before the build attempt times out",
"example": 120,
"minimum": 0
},
"config": {
"$ref": "#/components/schemas/Config"
}
},
"type": "object",
"additionalProperties": false
},
"ArtifactFileRequest": {
"description": "Artifact file metadata for upload",
"properties": {
"filename": {
"type": "string",
"example": "build.apk"
},
"size": {
"type": "integer",
"format": "int64",
"example": 1024000,
"minimum": 0
},
"md5sum": {
"type": "string",
"example": "abc123def456"
}
},
"required": [
"filename",
"size"
],
"type": "object",
"additionalProperties": false
},
"CreateArtifactRequestBody": {
"description": "Request body for creating an artifact",
"properties": {
"name": {
"type": "string",
"example": "primary"
},
"key": {
"type": "string",
"example": "android-build"
},
"primary": {
"type": "boolean",
"example": true
},
"public": {
"type": "boolean",
"example": false
},
"files": {
"items": {
"$ref": "#/components/schemas/ArtifactFileRequest"
},
"type": "array"
}
},
"required": [
"name",
"key",
"files"
],
"type": "object",
"additionalProperties": false
},
"TusResumableBinary": {
"type": "string",
"format": "binary",
"description": "Binary data for TUS resumable upload"
},
"DeletedBuild": {
"properties": {
"targetId": {
"type": "string"
},
"buildTargetAttemptCount": {
"type": "integer",
"format": "int64",
"minimum": 0
}
},
"type": "object",
"additionalProperties": false
},
"BatchDeleteBuildArtifactsResponse": {
"description": "Response for batchDeleteBuildArtifacts",
"properties": {
"numberOfDeletedBuildArtifacts": {
"type": "integer",
"format": "int64",
"example": 2,
"minimum": 0
},
"builds": {
"items": {
"$ref": "#/components/schemas/DeletedBuild"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"ExcludedBuilds": {
"description": "Excluded build information",
"properties": {
"buildId": {
"type": "string",
"example": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
},
"reason": {
"type": "string",
"example": "Build excluded due to configuration mismatch"
}
},
"type": "object",
"additionalProperties": false
},
"BatchDeleteBuildArtifactsRequestBody": {
"description": "Request body for batchDeleteBuildArtifacts",
"properties": {
"builds": {
"items": {
"$ref": "#/components/schemas/Build"
},
"type": "array"
},
"excludedBuilds": {
"items": {
"$ref": "#/components/schemas/ExcludedBuilds"
},
"type": "array"
},
"filters": {
"$ref": "#/components/schemas/Record_string.any_"
},
"deleteOnOrBeforeDate": {
"type": "string",
"format": "date-time"
}
},
"type": "object",
"additionalProperties": false
},
"CompleteDirectUploadResponse": {
"description": "Response for completing a direct upload",
"properties": {
"message": {
"type": "string",
"example": "Upload completed successfully"
},
"buildNumber": {
"type": "integer",
"format": "int64",
"example": 123,
"minimum": 0
},
"artifactName": {
"type": "string",
"example": ".ZIP file"
},
"storageKey": {
"type": "string",
"example": "org/project/_local-123/build.zip"
}
},
"required": [
"message",
"buildNumber",
"artifactName",
"storageKey"
],
"type": "object",
"additionalProperties": false
},
"CompleteDirectUploadFileRequest": {
"description": "File metadata for direct upload completion",
"properties": {
"filename": {
"type": "string",
"example": "build.zip"
},
"key": {
"type": "string",
"example": "build.zip"
},
"size": {
"type": "integer",
"format": "int64",
"example": 1024000,
"minimum": 0
}
},
"required": [
"filename"
],
"type": "object",
"additionalProperties": false
},
"CompleteDirectUploadArtifactRequest": {
"description": "Artifact metadata for direct upload completion",
"properties": {
"name": {
"type": "string",
"example": ".ZIP file"
},
"files": {
"items": {
"$ref": "#/components/schemas/CompleteDirectUploadFileRequest"
},
"type": "array"
},
"key": {
"type": "string",
"example": "primary"
},
"primary": {
"type": "boolean",
"example": true
}
},
"required": [
"name",
"files"
],
"type": "object",
"additionalProperties": false
},
"CompleteDirectUploadRequestBody": {
"description": "Request body for completing a direct upload",
"properties": {
"artifact": {
"$ref": "#/components/schemas/CompleteDirectUploadArtifactRequest"
},
"storageKey": {
"type": "string",
"example": "org/project/_local-123/build.zip"
}
},
"required": [
"artifact"
],
"type": "object",
"additionalProperties": false
},
"AndroidSdkResponse": {
"description": "Android SDK response",
"properties": {
"name": {
"type": "string",
"example": "Android SDK 31"
},
"value": {
"type": "string",
"example": "android_sdk_31"
}
},
"required": [
"name",
"value"
],
"type": "object",
"additionalProperties": false
},
"AndroidSdkConfigResponse": {
"description": "Android SDK configuration response",
"properties": {
"minUnityVersion": {
"type": "string",
"example": "2022_2_1f1"
},
"maxUnityVersion": {
"type": "string",
"example": "2023_1_1f1"
},
"ndkVersion": {
"type": "string",
"example": "android_ndk_r23b"
},
"sdkVersion": {
"type": "string",
"example": "android_sdk_33"
},
"allowAlphas": {
"type": "boolean",
"example": true
},
"allowBetas": {
"type": "boolean",
"example": true
}
},
"type": "object",
"additionalProperties": false
}
},
"securitySchemes": {
"basicAuth": {
"type": "http",
"scheme": "basic",
"description": "Service account key and secret, Base64-encoded as `keyId:secret` (HTTP Basic auth). Recommended for API clients and CI systems."
},
"jwt": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "Bearer token (Authorization header). Used by the Unity dashboard and interactive sessions."
}
}
}
}
```