Skip to content

Symbols files

APIs for interacting with iOS dSYMs and Android source code mapping files, commonly referred to as symbols files.

Upload a symbols file

POST https://api.appelium.com/v2/symbolsFiles

Use this method to automate symbols file upload directly from your CI/CD pipelines.

The symbols file is sent as the raw request body. All metadata is provided through X-Appelium-* request headers.

Parameters

NAME PLACEMENT TYPE DESCRIPTION
X-Appelium-Token
Required		 Header string API token generated in Dashboard.
X-Appelium-Application-Alias
Required		 Header string Application alias (visible in Application settings screen in Dashboard).
X-Appelium-Package
Required		 Header string Package name of the app.
X-Appelium-Version-Name
Required		 Header string Version name of the app.
X-Appelium-Version-Code
Required		 Header string Version code of the app.
Content-Type
Recommended		 Header string text/plain
Request body
Required		 Body binary Raw .txt file with source code mappings.

Example

curl -X POST "https://api.appelium.com/v2/symbolsFiles" \
    -H "X-Appelium-Token: <your-token>" \
    -H "X-Appelium-Application-Alias: <your-app-alias>" \
    -H "X-Appelium-Package: com.example.app" \
    -H "X-Appelium-Version-Name: 1.2.3" \
    -H "X-Appelium-Version-Code: 456" \
    -H "Content-Type: text/plain" \
    --data-binary @mapping.txt

Parameters

NAME PLACEMENT TYPE DESCRIPTION
X-Appelium-Token
Required		 Header string API token generated in Dashboard.
X-Appelium-Application-Alias
Required		 Header string Application alias (visible in Application settings screen in Dashboard).
Content-Type
Recommended		 Header string application/zip
Request body
Required		 Body binary Raw .zip archive containing all dSYMs. Bundle identifier, version and build number are read from the dSYM Info.plist.

Example

curl -X POST "https://api.appelium.com/v2/symbolsFiles" \
    -H "X-Appelium-Token: <your-token>" \
    -H "X-Appelium-Application-Alias: <your-app-alias>" \
    -H "Content-Type: application/zip" \
    --data-binary @dSYMs.zip

201: Created

In case the symbols file was successfully uploaded and processed.

401: Unauthorized

{
    "id": "388677B7-B016-4A6C-A8AE-887B3814114C",
    "httpStatus": 401,
    "title": "Unauthorized",
    "detail": "Invalid or missing X-Appelium-Token header"
}