REST API
Get familiar with the Applivery API and explore the features
Edit a Distribution Site
This endpoint is intended to edit an existing Distribution Site under your App Store.
Definition:
PUT https://api.applivery.io/v1/integrations/distributions/{distributionId}
- Authentication: required
- Headers:
- Content-Type: application/json
- Authorization: bearer <Your_App_Token>
Query Params:
| Param | Type | Description |
|---|---|---|
publishedApplicationId |
String |
Id. E.g.: 552ae3cfcb5abfc58d733b81 |
Body Params:
Note that only the provided params will be modified.
| Param | Type | Description |
|---|---|---|
slug |
String |
URL of the distribution site under the Store domain. E.g.: you.applivery.io/{slug} |
security |
String |
Visibility of your page. Options.: public, password or logged |
tags |
String |
Groups that will have access. Comma separated values. E.g.: group1,group2 |
password |
String |
Password to protect the Site. E.g.: $a&7%/?123 |
visibility |
String |
Visibility of your Site under the App Store. Options: active, inactive or unlisted |
showHistory |
Boolean |
Display or not the Builds history. Options: true or false |
filter.type |
String |
Filter the builds to distribute based on the information of the build itself. Useful to create multiple distribution lanes or tracks. Options.: – last: Last builds available for iOS and Android– builds: Specific build IDs (one for each OS)– tags: last build available matching matching a given set of tags– gitTag: last build available matching matching a given gitTag– gitBranch: last build available matching matching a given gitBranch |
filter.value |
String |
Value to use for the filter type. E.g.: develop for gitBranch type of distribution. Only available for: tag, gitTag or gitBranch type of distribution |
filter.ios |
String |
iOS Build ID. Only available for: builds type of distribution E.g.: 552ae3cfcb5abfc58d733b81 |
filter.android |
String |
Android Build ID. Only available for: builds type of distribution E.g.: 552ae3cfcb5abfc58d733b82 |
configuration.application.name |
String |
Overwrite application name. E.g.: My awesome App |
configuration.application.description |
String |
Overwrite application description. E.g.: This is my awesome App |
configuration.branding.logo |
String |
Overwrite application header logo. E.g.: https://... |
configuration.branding.primaryColor |
String |
Overwrite application header color. E.g.: #ffffff |
configuration.branding.buttonColor |
String |
Overwrite application install button color. E.g.: #ffffff |
terms.active |
Boolean |
Enable terms & conditions popup before installation E.g.: true or false |
terms.text |
String |
Terms & conditions full text. E.g.: By installing this App... |
showDevInfo |
Boolean |
Enable display Development info (git, certificates, etc). E.g.: true or false |
PUT Request Example
curl -X POST
https://api.applivery.io/v1/integrations/distributions/552ae3cfcb5abfc58d733b81
-H 'Authorization: Bearer xyz...xyz'
-H 'Content-Type: application/json'
-d '{
"slug": "myapp",
"security": "password",
"password": "1234567890",
"visibility": "active",
"showHistory": true,
"filter":{
"type": "tag",
"value": "tag1,tag2"
},
"configuration":{
"application":{
"name": "My custom App Name",
"description": "My custom App description"
},
"branding":{
"logo": "",
"primaryColor": "#ff0000",
"buttonColor": "#3fc10a"
}
},
"terms":{
"active": true,
"text": "My custom terms & conditions"
},
"showDevInfo": true,
"distributionUrl": "https://myorganization.applivery.io/myapp"
}'
Responses
{
"status":true,
"data":{
"id":"string",
"createdAt":"string",
"application":"string",
"slug":"string",
"filter":{
"type":"last",
"value":"string",
"ios":"string",
"android":"string"
},
"security":"public",
"tags":[
"string"
],
"visibility":"active",
"showHistory":true,
"terms":{
"active":true,
"text":"string"
},
"showDevInfo":true
}
}
{
"status": true,
"error": {
"code": 2001,
"message": "Token not valid"
}
}
{
"status": true,
"error": {
"code": 4001,
"message": "Entity not found"
}
}