API

To upload a build file directly from your CI/CD system we recommend using our api endpoint.

Upload a build file

post

Uploads a build file along with associated metadata.

Body

buildstring · binaryOptional

The build file to be uploaded.

organisation_keystringOptional

The organization key.

Example: ORG_KEY_12345

platformstringOptional

The platform for the build. Options are "android" or "ios".

Example: android

metadatastringOptional

Metadata as a JSON string.

Example: {"branch":"dev-feature-1"}

Responses

200

Build uploaded successfully

application/json

post

HTTPcURLJavaScriptPython

POST /uploadBuild/ HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 118

{
  "build": "binary",
  "organisation_key": "ORG_KEY_12345",
  "platform": "android",
  "metadata": "{\"branch\":\"dev-feature-1\"}"
}

200

Build uploaded successfully

{
  "buildId": "build_12345"
}

Examples

With a curl command:

curl -L \
  -X POST \
  -H "Content-Type: multipart/form-data" \
  -F "build=@path/to/your/build_file.apk" \
  -F "organisation_key=YOUR_ORGKEY_12345" \
  -F "platform=android" \
  -F "metadata={\"branch\":\"dev-feature-007\"}" \
  https://api.mobileboost.io/uploadBuild/