API v3 Migration Question – Looking for alternative endpoints for POST /builds and getting artifact download link

[appfast-codev]

If you are looking for help, please confirm the following...

• I confirm I have searched the Docs, Codemagic Sample Projects, and GitHub Discussions.
• I confirm the software versions on my local computer match the ones in CI environment (e.g. Xcode version, Gradle version). See here
• I confirm I am able to do a fresh clone of the repository and build the project on my local computer.

Which mobile framework are you using?

Flutter (Dart)

Steps to reproduce

Hello Codemagic Community,

I am in the process of upgrading my system from the old Codemagic API (referenced at docs.codemagic.io/rest-api/codemagic-rest-api/) to the new v3 API (as per the schema at codemagic.io/api/v3/schema and the document.json file).

My custom PHP library (CodeMagic.php) is failing because it relies on old endpoints (like POST /builds and GET /builds/{build_id}) that no longer appear to exist in v3.

I need help finding replacement v3 endpoints for 3 core functions:

1. Create a new build.

2. Check the status of that particular build.

3. Get the download URL of the artifact when the build is complete.

Steps to reproduce (Current Workflow is broken)

Here is my old logic flow and where it broke:

1. A controller (CreateBuild.php) calls the create_build() function in my library, which used to POST to /builds.

2. A background task (cron job) then calls the check_status() function to GET from /builds/{build_id} to check the status and get the artifact URL.

3. Since the endpoint in step 2 no longer exists, the static field (which stores the artifact URL) in my database is never updated and remains empty.

4. When the user attempts to download, the DownloadArtefact.php controller is called.

5. It fetches the build from the database (with the static field empty) and calls the signing_download_link('') function.

6. This function attempts to do a POST to $link."/public-url", (i.e. POST '/public-url'), which causes a fatal error.

Expected results

Expected Result

I'd like to find explicit alternative endpoints in the v3 API documentation (document.json) so I can update my CodeMagic.php library:

1. To create the build: An explicit POST endpoint, e.g. /api/v3/apps/{app_id}/builds, where I can pass the workflowId and branch (or equivalent parameters).

2. To check the status: An explicit GET endpoint, e.g. /api/v3/builds/{build_id}, so I can query the status of a single build.

3. To get the download link: An explicit field in the status endpoint's response (like short_lived_download_url mentioned in ArtifactSchema) that I can use directly, instead of the old POST .../public-url process.

Actual results

Actual results

1. No Build endpoint found: I can't find any POST endpoint in the document.json that is used to start a new build. The only build-related endpoint is POST /api/v3/builds/{build_id}/preview, but that is for "App Previews".

2. Specific Build Status Endpoint Not Found: I can't find GET /api/v3/builds/{build_id}. The closest endpoint is GET /api/v3/dashboards/{uuid}/builds, but it requires dashboard_uuid and returns a list of all builds, not a specific build.

3. CRITICAL Error: My system now crashes with the error:

CodeIgniter\HTTP\Exceptions\HTTPException: 6 : Could not resolve host: public-url in SYSTEMPATH/HTTP/CURLRequest.php on line 695

This is caused by step 5 in "Steps to reproduce" - the system is trying to POST to an invalid URL because the old v1 API no longer returns artifact data.

My questions are:

1. What is the correct v3 endpoint to start a new build (equivalent to the old POST /builds)?

2. What is the best practice in v3 to query the status of a single build? Do I have to call GET /api/v3/dashboards/{uuid}/builds and then filter the results myself in my app?

3. Can I confirm that the short_lived_download_url field in ArtifactSchema is a replacement for the old .../public-url endpoint and does not require any additional POST calls to trigger?

Thanks for any help!

Build id (optional)

No response

[Becca-Saka]

Hello @appfast-codev

To answer your questions,

There is currently no equivalent of POST /builds in the new v3 api and there is no ETA on when it will be available bit we will update the docs as soon as it is ready.

If you could share your build ID with me, I can investigate why your code stopped working. I checked the the endpoints and they work perfectly for me

[opanitch]

hey @Becca-Saka - are you saying that the old endpoints are still working as intended? I also am experiencing the same issue where the build assets are no longer available via the same method. It's an external pipeline that calls the API and would like to download the assets. This is the example curl

curl -s -H "Content-Type: application/json" -H "x-auth-token: $(ApiToken)" --request GET "https://api.codemagic.io/builds/68fbdc43cd630c3b4d72e01a?appId=65a0280486afefea98e65891&branch=main" | jq -r .build.artefacts[].url

the error I get is that the URL is empty

jq: error (at <stdin>:0): Cannot iterate over null (null)
url is empty: 

[Becca-Saka]

curl -s \
  -H "Content-Type: application/json" \
  -H "x-auth-token: xtoken" \
  --request GET \
  "https://api.codemagic.io/builds/x?appId=xy&branch=main" \
  | jq -r '.build.artefacts[].url'

Hi @opanitch , this works for me. You need to quote your jq expression. Let me know how it goes.

[appfast-codev]

hi @Becca-Saka , now my live build on codemagic is also failing, i haven't had a successful build in over a week.

I'm facing a very confusing build issue on Codemagic that I can't resolve, even after clearing caches.

Build ID: 6906cc7eccef91ef53c3cdb8

---

The Problem

My build is consistently failing at the :app:checkReleaseAarMetadata task, with an error message stating I am using Android Gradle Plugin (AGP) 8.1.0 and need to upgrade.

However, I have upgraded all my configuration files to AGP 8.6.0 and Gradle 8.8.

The Error Log

This is the error I receive at the build step:

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':app:checkReleaseAarMetadata'.
> A failure occurred while executing com.android.build.gradle.internal.tasks.CheckAarMetadataWorkAction
   > 2 issues were found when checking AAR metadata:

       1.  Dependency 'androidx.core:core:1.16.0' requires Android Gradle plugin 8.6.0 or higher.
           This build currently uses Android Gradle plugin 8.1.0.

       2.  Dependency 'androidx.core:core-ktx:1.16.0' requires Android Gradle plugin 8.6.0 or higher.
           This build currently uses Android Gradle plugin 8.1.0.

* Try:
> Run with --stacktrace option to get the stack trace.
> Run with --info or --debug option to get more log output.
> Run with --scan to get full insights.
> Get more help at [https://help.gradle.org](https://help.gradle.org).

BUILD FAILED in 4m 58s

---

The Debug Proof

The most confusing part is that I added a script step immediately before the build step to check the file contents. This debug script confirms that the files on the build machine are CORRECT.

Here is the output from my debug script:

#!/usr/bin/env bash

echo "--- Checking android/build.gradle ---"
# Print the line containing 'com.android.tools.build:gradle'
cat android/build.gradle | grep "com.android.tools.build:gradle"

echo "--- Checking android/gradle/wrapper/gradle-wrapper.properties ---"
# Print the line containing 'distributionUrl'
cat android/gradle/wrapper/gradle-wrapper.properties | grep "distributionUrl"

--- Checking android/build.gradle ---
        classpath 'com.android.tools.build:gradle:8.6.0'
--- Checking android/gradle/wrapper/gradle-wrapper.properties ---
distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-all.zip

---

Steps I Have Already Tried

As you can see, the debug script (running in Step 7) confirms the code is 8.6.0, but the build script (running in Step 8) immediately after it reports 8.1.0.

I have tried every possible way to clear the cache:

1. Clicking the "Clear cache" button in the Codemagic UI before starting the build.
2. Adding flutter clean to my codemagic.yaml.
3. Adding gradle: "8.8" to the environment block in codemagic.yaml.
4. Adding manual cache deletion commands to my codemagic.yaml:

   rm -rf $HOME/.gradle/caches/
   rm -rf $FCI_BUILD_DIR/android/.gradle/

My Question

Even after doing all of this, why is the Gradle task still "seeing" the old AGP version 8.1.0?

Is there another layer of caching I am missing? How can I force the build environment to 100% respect the updated configuration files?

Thank you for any help.

[Becca-Saka]

Hello @appfast-codev

Can you confirm if these files have been committed? Please double-check your .gitignore file.

1. gradlew.bat
2. gradlew
3. gradle/wrapper/gradle-wrapper.jar

[Becca-Saka]

Hello @appfast-codev, I am going to go ahead and close this, since I didn't hear back from you. You can reopen this if you are still experiencing the same issue.