Search Unity

Official Change to API's /log route (get a build log)

Discussion in 'Unity Build Automation' started by scotth-unity, Nov 4, 2022.

  1. scotth-unity

    scotth-unity

    Unity Technologies

    Joined:
    Sep 3, 2021
    Posts:
    12
    As part of our ongoing work to improve service latency, we are introducing a minor change to our route to get a build log, i.e.:

    /orgs/?/projects/?/buildtargets/?/builds/?/log


    If you are using this route for external automation:
    • The request contract and response payload will remain the same
    • Downloading logs for completed jobs should be substantially faster
    • However, calls to this route needs to be updated to follow redirects - without this, the response for most completed jobs will be empty
    • The behaviour for active jobs remains the same
    If you are using Curl, for example, be sure to include the -L option, e.g.:

    curl
    -L GET
    -H "Content-Type: application/json"
    -H "Authorization: Basic [YOUR API KEY]"
    https://build-api.cloud.unity3d.com/api/v1/orgs/?/projects/?/buildtargets/?/builds/?/log


    This change will be included in our next release, expected to be deployed on Tuesday, November 8 (which will include updates to our API docs).

    We urge you to update any automation beforehand, and I am sorry for the short notice here.

    Going forward, we will do everything possible to minimize changes to existing API behaviour and provide more visibility on upcoming changes that impact customers who have integrated Cloud Build into their own automation workflows.

    Thanks,
    Unity Cloud Build Team