Package: ucb-client
Unity Cloud Build ClientThis API is intended to be used in conjunction with the Unity Cloud Build service. A tool for building your Unity
projects in the Cloud. Seehttps://developer.cloud.unity3d.comfor more information.Making requestsThis website is built to allow requests to be made against the API. If you are currently logged into Cloud Build you should be able to
make requests without entering an API key. You can find your API key in the Unity Cloud Services portal by clicking on '
Cloud Build Preferences' in the sidebar. Copy the API Key and paste it into the upper left corner of this website. It
will be used in all subsequent requests.ClientsThe Unity Cloud Build API is based upon Swagger. Client libraries to integrate with your projects can easily be
generated with theSwagger Code Generator.
The JSON schema required to generate a client for this API version is located here:https://build-api.cloud.unity3d.com/api/v1/api.jsonAuthorizationThe Unity Cloud Build API requires an access token from your Unity Cloud Build account, which can be found by selectingSettingsunderDevOps > Cloud Buildathttps://dashboard.unity3d.com/cloud-buildTo authenticate requests, include a Basic Authentication header with your API key as the value. e.g.Authorization: Basic [YOUR API KEY]PaginationPaged results will take two parameters. A page number that is calculated based upon the per_page amount. For instance if
there are 40 results and you specify page 2 with per_page set to 10 you will receive records 11-20. Paged results will
also return a Content-Range header. For the example above the content range header would look like
this:Content-Range: items 11-20/40VersioningThe API version is indicated in the request URL. Upgrading to a newer API version can be done by changing the path.
The API will receive a new version in the following cases:removal of a path or request typeaddition of a required fieldremoval of a required fieldThe following changes are
considered backwards compatible and will not trigger a new API version:addition of an endpoint or request typeaddition of an optional fieldremoval of an optional fieldchanges to the format of idsIdentifiersIt should not be assumed that any of the identifiers used in paths will be a perfect match for your user-entered
information. If you
see unexpected 403s or 404s from API calls then check your identifiers match the ones used by the API. In
particular,projectIddoes NOT typically change when the project is renamed and in fact may not be a direct match for
the project name even at initial creation time. To avoid confusion we recommend that instead of using the human-readable
autogenerated orgId and projectId available from the API you should instead use:org foreign key fororgId(
available from project APIs asorgFkand org APIs ascoreForeignKey)guidforprojectIdAll links generated
by the API and the Dashboard should follow this format already, making it easy to figure out the correct parameters by
making a comparison.Rate LimitingRequests against the Cloud Build API are limited to a rate of 100 per minute. To preserve the quality of service
throughout Cloud Build, additional rate limits may apply to some actions. For example,
polling aggressively instead of using webhooks or making API calls with a high concurrency may result in rate limiting.
It is not intended for these rate limits to interfere with any legitimate use of the API. Please contact support
atcloudbuild@unity3d.comif your use is affected by this rate limit.
You can check the returned HTTP headers for any API request to see your current rate limit status.X-RateLimit-Limit:maximum number of requests per minuteX-RateLimit-Remaining:remaining number of requests in the current windowX-RateLimit-Reset:time at which the current window will reset (UTC epoch seconds)Once you go over the rate limit you will receive an error
response:HTTP Status: 429 
{
  "error": "Rate limit exceeded, retry in XX seconds" 
}About packageThis Python package is automatically generated by theSwagger Codegenproject:API version: 1.0.0Package version: 1.0.0Build package: io.swagger.codegen.languages.PythonClientCodegenRequirements.Python 2.7 and 3.4+Installation & Usagepip installYou can install the package directly fromGitHubpipinstallgit+https://github.com/Cookieees/ucb-client.gityou may need to runpipwith root permission:sudopipinstallgit+https://github.com/Cookieees/ucb-client.gitAlternatively, you can use pypi storage:pipinstallucb-clientThen import the package:importucb_clientSetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--user(orsudo python setup.py installto install the package for all users)Then import the package:importucb_clientGetting StartedPlease follow theinstallation procedureand then run the following:from__future__importprint_functionimporttimeimportucb_clientfromucb_client.restimportApiExceptionfrompprintimportpprint# Configure HTTP basic authorization: apikeyconfiguration=ucb_client.Configuration()configuration.api_key='YOUR_API_KEY'# Configure HTTP basic authorization: access_tokenconfiguration=ucb_client.Configuration()configuration.username='YOUR_USERNAME'configuration.password='YOUR_PASSWORD'# create an instance of the API classapi_instance=ucb_client.BillingApi(ucb_client.ApiClient(configuration))orgid='orgid_example'# str | Organization identifierprojectid='projectid_example'# str | Project identifiertry:# Get billing planapi_response=api_instance.billing_plan(orgid,projectid)pprint(api_response)exceptApiExceptionase:print("Exception when calling BillingApi->billing_plan:%s\n"%e)Documentation for API EndpointsAll URIs are relative tohttps://localhost/api/v1ClassMethodHTTP requestDescriptionBillingApibilling_planGET/orgs/{orgid}/projects/{projectid}/billingplan_alphaGet billing planBuildsApibatch_delete_build_artifactsPOST/orgs/{orgid}/projects/{projectid}/artifacts/deleteDelete artifacts for a batch of buildsBuildsApicancel_all_buildsDELETE/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/buildsCancel all buildsBuildsApicancel_buildDELETE/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}Cancel buildBuildsApicancel_builds_for_orgDELETE/orgs/{orgid}/buildsCancel builds for orgBuildsApicreate_sharePOST/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}/shareCreate a new link to share a projectBuildsApidelete_all_build_artifactsDELETE/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/artifactsDelete all artifacts associated with all non-favorited builds for a specified buildtargetid (_all is allowed).BuildsApidelete_build_artifactsDELETE/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}/artifactsDelete all artifacts associated with a specific buildBuildsApiget_audit_logGET/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}/auditlogGet audit logBuildsApiget_audit_log_for_build_targetGET/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/auditlogGet audit logBuildsApiget_buildGET/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}Build StatusBuildsApiget_build_logGET/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}/logGet build logBuildsApiget_build_stepsGET/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}/stepsGet the build steps for a given buildBuildsApiget_buildsGET/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/buildsList all buildsBuildsApiget_builds_for_orgGET/orgs/{orgid}/buildsList all builds for orgBuildsApiget_shareGET/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}/shareGet the share linkBuildsApimodify_sharePUT/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}/shareModify existing share linkBuildsApiresign_build_artifactPOST/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}/resignRe-sign a build artifactBuildsApirevoke_shareDELETE/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}/shareRevoke a shared linkBuildsApistart_buildsPOST/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/buildsCreate new buildBuildsApiupdate_buildPUT/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/builds/{number}Update build informationBuildtargetsApiadd_build_targetPOST/orgs/{orgid}/projects/{projectid}/buildtargetsCreate build target for a projectBuildtargetsApidelete_build_targetDELETE/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}Delete build targetBuildtargetsApiget_build_targetGET/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}Get a build targetBuildtargetsApiget_build_targetsGET/orgs/{orgid}/projects/{projectid}/buildtargetsList all build targets for a projectBuildtargetsApiget_build_targets_for_orgGET/orgs/{orgid}/buildtargetsList all build targets for an orgBuildtargetsApiget_env_variables_for_build_targetGET/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/envvarsGet environment variablesBuildtargetsApiget_stats_for_build_targetGET/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/statsGet build target statisticsBuildtargetsApiset_env_variables_for_build_targetPUT/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}/envvarsSet environment variablesBuildtargetsApiupdate_build_targetPUT/orgs/{orgid}/projects/{projectid}/buildtargets/{buildtargetid}Update build target detailsConfigApiget_versionGET/versions/unity/{key}Get a unity version by valueConfigApilist_scms_supporting_version_auto_detectGET/versions/auto_detect_supported_scmsList all SCM types supporting auto detecting the project Unity versionConfigApilist_unity_versionsGET/versions/unityList all unity versionsConfigApilist_xcode_versionsGET/versions/xcodeList all xcode versionsCredentialsApiadd_credentials_androidPOST/orgs/{orgid}/projects/{projectid}/credentials/signing/androidUpload Android CredentialsCredentialsApiadd_credentials_android_for_orgPOST/orgs/{orgid}/credentials/signing/androidUpload Android CredentialsCredentialsApiadd_credentials_iosPOST/orgs/{orgid}/projects/{projectid}/credentials/signing/iosUpload iOS CredentialsCredentialsApiadd_credentials_ios_for_orgPOST/orgs/{orgid}/credentials/signing/iosUpload iOS Credentials for organizationCredentialsApiadd_credentials_osxPOST/orgs/{orgid}/projects/{projectid}/credentials/signing/osxUpload OSX CredentialsCredentialsApiadd_credentials_osx_for_orgPOST/orgs/{orgid}/credentials/signing/osxUpload OSX Credentials for organizationCredentialsApidelete_androidDELETE/orgs/{orgid}/projects/{projectid}/credentials/signing/android/{credentialid}Delete Android CredentialsCredentialsApidelete_android_for_orgDELETE/orgs/{orgid}/credentials/signing/android/{credentialid}Delete Android Credentials for organizationCredentialsApidelete_iosDELETE/orgs/{orgid}/projects/{projectid}/credentials/signing/ios/{credentialid}Delete iOS CredentialsCredentialsApidelete_ios_for_orgDELETE/orgs/{orgid}/credentials/signing/ios/{credentialid}Delete iOS Credentials for organizationCredentialsApidelete_osxDELETE/orgs/{orgid}/projects/{projectid}/credentials/signing/osx/{credentialid}Delete OSX CredentialsCredentialsApidelete_osx_for_orgDELETE/orgs/{orgid}/credentials/signing/osx/{credentialid}Delete OSX Credentials for organizationCredentialsApiget_all_androidGET/orgs/{orgid}/projects/{projectid}/credentials/signing/androidGet All Android CredentialsCredentialsApiget_all_android_for_orgGET/orgs/{orgid}/credentials/signing/androidGet All Android Credentials for an organizationCredentialsApiget_all_iosGET/orgs/{orgid}/projects/{projectid}/credentials/signing/iosGet All iOS CredentialsCredentialsApiget_all_ios_for_orgGET/orgs/{orgid}/credentials/signing/iosGet All iOS Credentials for an oganizationCredentialsApiget_all_osxGET/orgs/{orgid}/projects/{projectid}/credentials/signing/osxGet All OSX CredentialsCredentialsApiget_all_osx_for_orgGET/orgs/{orgid}/credentials/signing/osxGet All OSX Credentials for an oganizationCredentialsApiget_one_androidGET/orgs/{orgid}/projects/{projectid}/credentials/signing/android/{credentialid}Get Android Credential DetailsCredentialsApiget_one_android_for_orgGET/orgs/{orgid}/credentials/signing/android/{credentialid}Get Android Credential Details for organizationCredentialsApiget_one_iosGET/orgs/{orgid}/projects/{projectid}/credentials/signing/ios/{credentialid}Get iOS Credential DetailsCredentialsApiget_one_ios_for_orgGET/orgs/{orgid}/credentials/signing/ios/{credentialid}Get iOS Credential Details for organizationCredentialsApiget_one_osxGET/orgs/{orgid}/projects/{projectid}/credentials/signing/osx/{credentialid}Get OSX Credential DetailsCredentialsApiget_one_osx_for_orgGET/orgs/{orgid}/credentials/signing/osx/{credentialid}Get OSX Credential Details for organizationCredentialsApiupdate_androidPUT/orgs/{orgid}/projects/{projectid}/credentials/signing/android/{credentialid}Update Android CredentialsCredentialsApiupdate_android_for_orgPUT/orgs/{orgid}/credentials/signing/android/{credentialid}Update Android Credentials for organizationCredentialsApiupdate_iosPUT/orgs/{orgid}/projects/{projectid}/credentials/signing/ios/{credentialid}Update iOS CredentialsCredentialsApiupdate_ios_for_orgPUT/orgs/{orgid}/credentials/signing/ios/{credentialid}Update iOS Credentials for organizationCredentialsApiupdate_osxPUT/orgs/{orgid}/projects/{projectid}/credentials/signing/osx/{credentialid}Update OSX CredentialsCredentialsApiupdate_osx_for_orgPUT/orgs/{orgid}/credentials/signing/osx/{credentialid}Update OSX Credentials for organizationOrgsApiget_billing_plansGET/orgs/{orgid}/billingplanGet billing planOrgsApiget_ssh_key_for_orgGET/orgs/{orgid}/sshkeyGet SSH KeyOrgsApiregenerate_ssh_keyPOST/orgs/{orgid}/sshkeyRegenerate SSH KeyProjectsApiadd_projectPOST/orgs/{orgid}/projectsCreate projectProjectsApiarchive_projectDELETE/orgs/{orgid}/projects/{projectid}Archive projectProjectsApibilling_planGET/orgs/{orgid}/projects/{projectid}/billingplan_alphaGet billing planProjectsApiget_audit_log_for_projectGET/orgs/{orgid}/projects/{projectid}/auditlogGet audit logProjectsApiget_billing_plans_for_projectGET/orgs/{orgid}/projects/{projectid}/billingplanGet billing planProjectsApiget_env_variables_for_projectGET/orgs/{orgid}/projects/{projectid}/envvarsGet environment variablesProjectsApiget_projectGET/orgs/{orgid}/projects/{projectid}Get project detailsProjectsApiget_project_by_upidGET/projects/{projectupid}Get project detailsProjectsApiget_ssh_key_for_projectGET/orgs/{orgid}/projects/{projectid}/sshkeyGet SSH KeyProjectsApiget_stats_for_projectGET/orgs/{orgid}/projects/{projectid}/statsGet project statisticsProjectsApilist_projects_for_orgGET/orgs/{orgid}/projectsList all projects (org)ProjectsApilist_projects_for_userGET/projectsList all projects (user)ProjectsApiset_env_variables_for_projectPUT/orgs/{orgid}/projects/{projectid}/envvarsSet environment variablesProjectsApiupdate_projectPUT/orgs/{orgid}/projects/{projectid}Update project detailsPublicApiget_change_logsGET/changelogsGet the Unity Cloud Build changelogsSharesApiget_share_metadataGET/shares/{shareid}Get details on shared build including download linkStatusApiget_statusGET/statusGet Cloud Build StatusUserdevicesApicreate_devicePOST/users/me/devicesCreate iOS device profileUserdevicesApilist_devices_for_userGET/users/me/devicesList iOS device profilesUsersApiget_user_api_keyGET/users/me/apikeyGet current user's API keyUsersApiget_user_selfGET/users/meGet current userUsersApiregen_api_keyPOST/users/me/apikeyRegenerate API KeyUsersApiupdate_user_selfPUT/users/meUpdate current userWebhooksApiadd_hook_for_orgPOST/orgs/{orgid}/hooksAdd hook for organizationWebhooksApiadd_hook_for_projectPOST/orgs/{orgid}/projects/{projectid}/hooksAdd hook for projectWebhooksApidelete_hook_for_orgDELETE/orgs/{orgid}/hooks/{id}Delete organization hookWebhooksApidelete_hook_for_projectDELETE/orgs/{orgid}/projects/{projectid}/hooks/{id}Delete project hookWebhooksApiget_hook_for_orgGET/orgs/{orgid}/hooks/{id}Get organization hook detailsWebhooksApiget_hook_for_projectGET/orgs/{orgid}/projects/{projectid}/hooks/{id}Get project hook detailsWebhooksApilist_hooks_for_orgGET/orgs/{orgid}/hooksList hooks for organizationWebhooksApilist_hooks_for_projectGET/orgs/{orgid}/projects/{projectid}/hooksList hooks for projectWebhooksApiping_hook_for_orgPOST/orgs/{orgid}/hooks/{id}/pingPing an org hookWebhooksApiping_hook_for_projectPOST/orgs/{orgid}/projects/{projectid}/hooks/{id}/pingPing a project hookWebhooksApiupdate_hook_for_orgPUT/orgs/{orgid}/hooks/{id}Update hook for organizationWebhooksApiupdate_hook_for_projectPUT/orgs/{orgid}/projects/{projectid}/hooks/{id}Update hook for projectDocumentation For ModelsInlineResponse200InlineResponse2001InlineResponse20010InlineResponse20011InlineResponse20012InlineResponse2002InlineResponse2003InlineResponse2004InlineResponse2005InlineResponse2006InlineResponse2007InlineResponse2008InlineResponse2009OptionsOptions1Options10Options2Options3Options4Options5Options6Options7Options8Options9OrgsorgidcredentialssigningandroidKeystoreOrgsorgidcredentialssigningiosProvisioningProfileOrgsorgidcredentialssigningosxCertificateOrgsorgidprojectsprojectidartifactsdeleteBuildsOrgsorgidprojectsprojectidauditlogLinesOrgsorgidprojectsprojectidbuildtargetsBuildReportOrgsorgidprojectsprojectidbuildtargetsBuildsOrgsorgidprojectsprojectidbuildtargetsCredentialsOrgsorgidprojectsprojectidbuildtargetsCredentials1OrgsorgidprojectsprojectidbuildtargetsCredentials1SigningOrgsorgidprojectsprojectidbuildtargetsCredentialsSigningOrgsorgidprojectsprojectidbuildtargetsCredentialsSigningCredentialResourceRefOrgsorgidprojectsprojectidbuildtargetsCredentialsSigningCredentialResourceRefCertificateOrgsorgidprojectsprojectidbuildtargetsCredentialsSigningCredentialResourceRefKeystoreOrgsorgidprojectsprojectidbuildtargetsCredentialsSigningCredentialResourceRefProvisioningProfileOrgsorgidprojectsprojectidbuildtargetsFailureDetailsOrgsorgidprojectsprojectidbuildtargetsLastBuiltOrgsorgidprojectsprojectidbuildtargetsLinksOrgsorgidprojectsprojectidbuildtargetsProjectVersionOrgsorgidprojectsprojectidbuildtargetsSettingsOrgsorgidprojectsprojectidbuildtargetsSettingsAdvancedOrgsorgidprojectsprojectidbuildtargetsSettingsAdvancedAndroidOrgsorgidprojectsprojectidbuildtargetsSettingsAdvancedUnityOrgsorgidprojectsprojectidbuildtargetsSettingsAdvancedUnityAddressablesOrgsorgidprojectsprojectidbuildtargetsSettingsAdvancedUnityAddressablesContentUpdateSettingsOrgsorgidprojectsprojectidbuildtargetsSettingsAdvancedUnityAssetBundlesOrgsorgidprojectsprojectidbuildtargetsSettingsAdvancedUnityEditorUserBuildSettingsOrgsorgidprojectsprojectidbuildtargetsSettingsAdvancedUnityPlayerExporterOrgsorgidprojectsprojectidbuildtargetsSettingsAdvancedUnityPlayerSettingsOrgsorgidprojectsprojectidbuildtargetsSettingsAdvancedUnityPlayerSettingsAndroidOrgsorgidprojectsprojectidbuildtargetsSettingsAdvancedXcodeOrgsorgidprojectsprojectidbuildtargetsSettingsBuildScheduleOrgsorgidprojectsprojectidbuildtargetsSettingsPlatformOrgsorgidprojectsprojectidbuildtargetsSettingsScmOrgsorgidprojectsprojectidbuildtargetsTestResultsOrgsorgidprojectsprojectidbuildtargetsbuildtargetidbuildsnumberstepsMessagesShareExpiryShareExpiry1Documentation For AuthorizationapikeyType: HTTP basic authenticationfiletokenType: OAuthFlow: implicitAuthorization URL:https://build.cloud.unity3d.com/login/Scopes:org:user: must have at least user permissions in the organizationorg:manager: must have at least manager permissions in the organizationproject:user: must have at least user permissions in the projectproject:manager: must have at least manager permissions in the projectadmin: administrative privilegesadmin_readstats: administrative read stats privilegesAuthor Artem Gusintsev