Skip to main content
Version: 24.05

Remove symbol

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/remove_symbol

Overview​

Deletes a symbol document and its stored file(s).

Authentication​

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

Permissions​

  • Required permission: Delete on the crashes feature

Request Parameters​

ParameterTypeRequiredDescription
app_idStringYesApplication identifier
idStringYesSymbol document ID
api_keyStringYes (or auth_token)API key authentication
auth_tokenStringYes (or api_key)Auth token authentication

Examples​

Example 1: Remove symbol​

/i/crash_symbols/remove_symbol?api_key=YOUR_API_KEY&app_id=5f9c8a3b4d1e2a001f3b4567&id=65c5e0732c5f5300121a0020

Response​

Success Response​

{
"result": "Success"
}

Response Fields​

FieldTypeDescription
resultStringOperation result

Error Responses​

HTTP StatusResponse
400{ "result": "Missing id" }
404{ "result": "Symbol file data <id> not found" }
500{ "result": "Error when fetching symbol file data with id <id>" }
500{ "result": "Error removing symbol file data" }

Behavior​

  1. Loads symbol doc to resolve single-file vs multi-file storage keys.
  2. Deletes all related files from symbol storage.
  3. Removes metadata document from app symbol collection.
Implementation details

Database Collections

CollectionUsed forData touched 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.