Sign in

v1

latestSwagger 2.02026-07-132525401.9 MB
distribute

Get a release with id release_id. If release_id is latest, return the latest release that was distributed to the current user (from all the distribution groups).

get/v0.1/apps/{owner_name}/{app_name}/releases/{release_id}

Path parameters

release_idstring required

The ID of the release, or latest to get the latest release from all the distribution groups assigned to the current user.

owner_namestring required

The name of the owner

app_namestring required

The name of the application

Query parameters

udidstring

when supplied, this call will also check if the given UDID is provisioned. Will be ignored for non-iOS platforms. The value will be returned in the property is_udid_provisioned.

is_install_pageboolean

The check if the request is from Install page

Response

Success

idinteger required

ID identifying this unique release.

app_namestring required

The app's name (extracted from the uploaded release).

app_display_namestring required

The app's display name.

app_osstring

The app's OS.

versionstring required

The release's version.<br> For iOS: CFBundleVersion from info.plist. For Android: android:versionCode from AppManifest.xml.

origin'hockeyapp' | 'appcenter'

The release's origin

short_versionstring required

The release's short version.<br> For iOS: CFBundleShortVersionString from info.plist. For Android: android:versionName from AppManifest.xml.

release_notesstring

The release's release notes.

provisioning_profile_namestring

The release's provisioning profile name.

provisioning_profile_type'adhoc' | 'enterprise' | 'other'

The type of the provisioning profile for the requested app version.

provisioning_profile_expiry_datestring

expiration date of provisioning profile in UTC format.

is_provisioning_profile_syncingboolean

A flag that determines whether the release's provisioning profile is still extracted or not.

sizeinteger

The release's size in bytes.

min_osstring

The release's minimum required operating system.

device_familystring

The release's device family.

android_min_api_levelstring

The release's minimum required Android API level.

bundle_identifierstring

The identifier of the apps bundle.

package_hashesstring[]

Hashes for the packages.

fingerprintstring

MD5 checksum of the release binary.

uploaded_atstring required

UTC time in ISO 8601 format of the uploaded time.

download_urlstring

The URL that hosts the binary for this release.

secondary_download_urlstring

The URL that hosts the secondary binary for this release, such as the apk file for aab releases.

app_icon_urlstring required

A URL to the app's icon.

install_urlstring

The href required to install a release on a mobile device. On iOS devices will be prefixed with itms-services://?action=download-manifest&url=

destination_type'group' | 'store' | 'tester'

OBSOLETE. Will be removed in next version. The destination type.<br> <b>group</b>: The release distributed to internal groups and distribution_groups details will be returned.<br> <b>store</b>: The release distributed to external stores and distribution_stores details will be returned.<br> <b>tester</b>: The release distributed testers details will be returned.<br>

is_udid_provisionedboolean

In calls that allow passing udid in the query string, this value will hold the provisioning status of that UDID in this release. Will be ignored for non-iOS platforms.

can_resignboolean

In calls that allow passing udid in the query string, this value determines if a release can be re-signed. When true, after a re-sign, the tester will be able to install the release from his registered devices. Will not be returned for non-iOS platforms.

enabledboolean required

This value determines the whether a release currently is enabled or disabled.

statusstring

Status of the release.

is_external_buildboolean

This value determines if a release is external or not.