Skip to main content
Version: 4.x

Debug File APIs

Upload debug file​

This allows you to upload an single iOS, Android debug file.

Debug file accepts:

  • iOS: a Zipped dSYM file
  • Android: a Zipped file includes mapping.txt, R.txt or AndroidManifest.xml files.
POST /api/debug_files/upload

Parameters​

info

Authentication required.

AttributeTypeRequiredDescription
channel_keyStringtrueChannel key
fileFiletrueZip 压缩文件后的调试文件
release_versionStringtrue发布版本号,iOS 类型可忽略该参数
build_versionStringtrue内部版本号,iOS 类型可忽略该参数

Return body​

{
"id": 1,
"app_name": "Demo App",
"device_type": "ios",
"release_version": "1.14.0",
"build_version": "980",
"file_url": "https://tryzealot.ews.im/download/debug_files/1",
"metadata": [
{
"id": 1,
"debug_file_id": 1,
"uuid": "34656552-21ae-3722-a7fb-3582bc9b1d98",
"type": "arm64",
"object": "AppName",
"data": {},
"size": 4137941,
"created_at": "2022-11-25T15:53:15.157+08:00",
"updated_at": "2022-11-25T15:53:15.157+08:00"
}
]
}

Download debug file​

This allows you to download an single iOS, Android debug file.

POST /api/debug_files/download

Parameters​

AttributeTypeRequiredDescription
channel_keyStringtrueChannel key
release_versionStringtrue发布版本号,iOS 类型可忽略该参数
build_versionStringfalse内部版本号,iOS 类型可忽略该参数
orderStringfalse获取最新的方式,可选值有:
version = 最新版本 和 upload_date = 最新上传时间
仅限接受 release_version 值为 latest 有效

Return body​

  • 版本存在返回 200 状态码并返回 302 重定向到下载地址
  • 版本不存在返回 404 状态码和错误信息

List debug files​

Get a list of debug files.

This function takes pagination parameters page and per_page to restrict the list of debug files.

GET /api/debug_files

Parameters​

AttributeTypeRequiredDescription
channel_keyStringtrueChannel key
pageIntegerfalsePage number (default: 1)
per_pageIntegerfalseNumber of items to list per page (default: 25, max: 100).

Return body​

[
{
"id": 1,
"app_name": "Demo App",
"device_type": "ios",
"release_version": "1.14.0",
"build_version": "980",
"file_url": "https://tryzealot.ews.im/download/debug_files/1",
"metadata": [
{
"id": 1,
"debug_file_id": 1,
"uuid": "34656552-21ae-3722-a7fb-3582bc9b1d98",
"type": "arm64",
"object": "AppName",
"data": {},
"size": 4137941,
"created_at": "2022-11-25T15:53:15.157+08:00",
"updated_at": "2022-11-25T15:53:15.157+08:00"
}
]
}
]

Get a debug file​

Allows you to receive information about debug file like name, file size, UUID (iOS only), platform (iOS only) or file list (Android only).

GET /api/debug_files/:id

Parameters​

info

Authentication required.

AttributeTypeRequiredDescription
channel_keyStringtrueChannel key
idStringtrueID

Return body​

{
"id": 1,
"app_name": "Demo App",
"device_type": "ios",
"release_version": "1.14.0",
"build_version": "980",
"file_url": "https://tryzealot.ews.im/download/debug_files/1",
"metadata": [
{
"id": 1,
"debug_file_id": 1,
"uuid": "34656552-21ae-3722-a7fb-3582bc9b1d98",
"type": "arm64",
"object": "AppName",
"data": {},
"size": 4137941,
"created_at": "2022-11-25T15:53:15.157+08:00",
"updated_at": "2022-11-25T15:53:15.157+08:00"
}
]
}

Update a existed debug file​

This allows you to update a debug file.

PUT /api/debug_files/:id

Parameters​

info

Authentication required.

AttributeTypeRequiredDescription
channel_keyStringtrueChannel key
idStringtrueID
fileFiletruea Zipped debug file
release_versionStringtrue发布版本号,iOS 类型可忽略该参数
build_versionStringtrue内部版本号,iOS 类型可忽略该参数

Return body​

{
"id": 1,
"app_name": "Demo App",
"device_type": "ios",
"release_version": "1.14.0",
"build_version": "980",
"file_url": "https://tryzealot.ews.im/download/debug_files/1",
"metadata": [
{
"id": 1,
"debug_file_id": 1,
"uuid": "34656552-21ae-3722-a7fb-3582bc9b1d98",
"type": "arm64",
"object": "AppName",
"data": {},
"size": 4137941,
"created_at": "2022-11-25T15:53:15.157+08:00",
"updated_at": "2022-11-25T15:53:15.157+08:00"
}
]
}

Delete a debug file​

This allows you to delete a debug file.

DELETE /api/debug_files/:id

Parameters​

info

Authentication required.

AttributeTypeRequiredDescription
channel_keyStringtrueChannel key
idStringtrueID

Return body​

{
"mesage": "OK"
}