This request is intended to upload a new Build (.ipa, .apk, or .aab). These are the default file extensions you can upload to your Workspace. You can read more about Custom Build Platforms here.
Definition #
- Method: POST
- URL:
https://upload.applivery.io/v1/integrations/builds - Authentication: required
- Headers:
Content-Type: application/json
Authorization: bearer <your_app_token> - Request type: Multipart.
Params #
Param
Type
Description
versionName
String
Human readable version name for this build. E.g.: RC-1.
tags
Array
Comma separated tags. E.g.: tag1, tag2, tag3.
changelog
String
Build release notes or log of changes E.g.: Bug fixing!.
filter
Nested array of strings
List of groups that will be notified with support for AND / OR clauses. Each element within the same array will be considered as AND while each array will be an OR clause. E.g.: To notify users in group1 AND group2 OR in group3 use: [["group1", "group2"], ["group3"]].
packageName
String
Required if the build is not processable.
packageVersion
String
Required if the build is not processable.
packageIcon
File
Required if the build is not processable (in .png or .jpeg format).
notifyCollaborators
Boolean
Notify App and Organization collaborators. E.g.: true.
notifyEmployees
Boolean
Notify App and Organization employees. E.g.: true.
notifyMessage
String
Notification message to send in the email. E.g.: Enjoy the App!.
notifyLanguage
String
"es", "en", "fr", "ge", "it", "zh", "pt", "ru".
deployer.name
String
Custom deployer display name. E.g.: Jenkins CI.
deployer.info.commitMessage
String
Git commit message. E.g.: Fixed issue #123.
deployer.info.commit
String
Git commit. E.g.: f52ace0.
deployer.info.branch
String
Git branch. E.g.: develop.
deployer.info.tag
String
Git tag. E.g.: RC-1.
deployer.info.triggerTimestamp
String
CI trigger date/time. E.g.: 1558359012580.
deployer.info.buildUrl
String
CI build URL. E.g.: https://....
deployer.info.ciUrl
String
CI platform URL. E.g.: https://....
deployer.info.repositoryUrl
String
Version control repository URL. E.g.: https://....
deployer.info.buildNumber
String
CI platform build number. E.g.: 73.
Example request #
curl 'https://upload.applivery.io/v1/integrations/builds' \
-X POST \
--retry 5 \
--fail \
-H 'Authorization: bearer xyz...xyz' \
-F build=@'file.ipa' \
-F 'versionName=My awesome app version' \
-F 'tags=tag1, tag2, tag3' \
-F 'changelog=Bug fixing' \
-F notifyCollaborators=false \
-F notifyEmployees=false \
-F 'notifyMessage=Enjoy the App' \
-F 'notifyLanguage=en' \
-F 'filter[0][0]=group1' \
-F 'filter[0][1]=group2' \
-F 'filter[1][0]=group3' \
-F 'deployer.name=Custom CI PLatform' \
-F 'deployer.info.commitMessage=Fixed issue 123' \
-F 'deployer.info.commit=f52ace0' \
-F 'deployer.info.branch=develop' \
-F 'deployer.info.tag=RC-1' \
-F 'deployer.info.triggerTimestamp=1558359012580' \
-F 'deployer.info.buildUrl=http://www.applivery.io/build/73' \
-F 'deployer.info.ciUrl=http://www.applivery.io/ci' \
-F 'deployer.info.repositoryUrl=https://github.com/applivery/applivery-ios-sdk' \
-F 'deployer.info.buildNumber=173'
Responses #
application/json
{
"status": true,
"data": {
"id": "string",
"status": "pending",
"tags": ["string"],
"versionName": "string",
"application": "string",
"applicationInfo": {
"id": "string",
"name": "string",
"slug": "string",
"picture": "string"
},
"changelog": "string",
"info": {
"icon": "string",
"android": {
"targetSdkVersion": "string",
"minSDKVersion": "string",
"packageName": "string",
"platformBuildVersionName": "string",
"platformBuildVersionCode": "string",
"versionName": "string",
"versionCode": "string",
"icon": "string"
},
"ios": {
"plist": {
"CFBundleDisplayName": "string",
"CFBundleSupportedPlatforms": ["string"],
"MinimumOSVersion": "string",
"CFBundleIdentifier": "string",
"CFBundleShortVersionString": "string",
"CFBundleVersion": "string",
"CFBundleName": "string",
"CFBundleIcons": ["string"],
"UIDeviceFamily": ["string"]
},
"mobileprovision": {
"ExpirationDate": "2019-08-24T14:15:22Z",
"TeamIdentifier": "string",
"ProvisionsAllDevices": true,
"TeamName": "string",
"ProvisionedDevices": "string",
"signingType": "ad-hoc"
}
},
"pkg": {
"CFBundleDisplayName": "string",
"CFBundleSupportedPlatforms": ["string"],
"MinimumOSVersion": "string",
"CFBundleIdentifier": "string",
"CFBundleShortVersionString": "string",
"CFBundleVersion": "string",
"CFBundleName": "string"
}
},
"size": 0,
"processTime": 0,
"queuedTime": 0,
"versionCode": "string",
"error": "string",
"errorCode": "string",
"os": "ios",
"deployer": {
"name": "string",
"info": {
"commitMessage": "string",
"commit": "string",
"branch": "string",
"triggerTimestamp": "string",
"buildUrl": "string",
"ciUrl": "string",
"repositoryUrl": "string",
"buildNumber": "string",
"tag": "string"
}
},
"uploadedBy": {
"id": "string",
"email": "user@example.com",
"firstName": "string",
"lastName": "string",
"picture": "string"
},
"originalExtension": "string",
"storageProvider": {
"id": "string",
"name": "string",
"region": "string",
"config": "string"
},
"hasEmmJson": true,
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}
}
application/json
{
"status": false,
"error": {
"code": 5024,
"message": "Slug already used"
}
}
application/json
{
"status": false,
"error": {
"code": 3002,
"message": "Token Expired"
}
}
application/json
{
"status": false,
"error": {
"code": 3001,
"message": "Entity not found"
}
}