Skip to main content

Upload symbol (SDK)

Enterprise

This endpoint is part of Countly Enterprise. To get access, contact sales or compare versions. Existing customers can reach the support portal with questions.

Endpoint

/i/crash_symbols/upload_symbol

Overview

Uploads symbol files using app_key instead of dashboard member authentication.

Authentication

  • Authentication method: app_key
  • app_key is resolved to app, then upload flow reuses the same validations as add-symbol.

Permissions

  • No dashboard feature permission check is applied.
  • Access is controlled by valid app_key.

Request Parameters

ParameterTypeRequiredDescription
app_keyStringYesApplication key
platformStringYesPlatform (android, ios, javascript, etc.)
buildStringYesBuild identifier (string, comma-list, or JSON array string)
symbolsFileYes for single-file uploadsUploaded file
symbols[]File ArrayYes for JavaScript multi-file uploadsMultiple source map files
sym_tool_verStringNoSymbol tool version (defaults to unknown if omitted)
timestampNumberNoOptional upload timestamp input for time init
noteStringNoOptional note

Examples

Example 1: SDK tool upload

curl -X POST "https://your-server.com/i/crash_symbols/upload_symbol" \
-F "app_key=YOUR_APP_KEY" \
-F "platform=ios" \
-F "build=A1B2C3D4-1234-5678-ABCD-1234567890EF" \
-F "symbols=@symbols.zip" \
-F "sym_tool_ver=2.3.0"

Response

Success Response

{
"message": "Success",
"_id": "65c5e0732c5f5300121a0020"
}

Response Fields

FieldTypeDescription
messageStringSuccess message
_idStringCreated symbol document ID

Error Responses

HTTP StatusResponse
401{ "result": "App does not exist" }
400Same upload validation errors as Add Symbol
500{ "result": "Error creating symbol file directory" }
500{ "result": "Error saving symbol files" }

Behavior

  1. Resolves app by app_key.
  2. Sets default sym_tool_ver=unknown when missing.
  3. Executes shared upload flow (handleSymbolFileUpload).
Implementation details

Database Collections

CollectionUsed forData touched by this endpoint
countly.appsApp configuration and metadataStores app-level feature settings and metadata used or modified by this endpoint.
countly.app_crashsymbols{app_id}Endpoint data sourceStores endpoint-related records this endpoint reads or modifies.
countly_fs.crash_symbolsEndpoint data sourceStores endpoint-related records this endpoint reads or modifies.