Skip to main content

Test symbolication API key

Endpoint

/o/symbolication/test_symbolication_key

Enterprise Only
This API is available exclusively in Countly Enterprise.

Overview

Checks whether a symbolication server accepts a provided symbolication API key.

Authentication

  • Authentication methods:
    • API Key (parameter): api_key=YOUR_API_KEY
    • Auth Token (parameter): auth_token=YOUR_AUTH_TOKEN
    • Auth Token (header): countly-token: YOUR_AUTH_TOKEN

Permissions

  • Required permission: Read on the crashes feature

Request Parameters

ParameterTypeRequiredDescription
server_urlStringYesSymbolication server base URL.
symb_keyStringYesSymbolication server API key to test.
api_keyStringYes (or auth_token)API key authentication.
auth_tokenStringYes (or api_key)Auth token authentication.

Response

Success Response

true

Response Fields

FieldTypeDescription
(root value)BooleanKey validation status.

Error Responses

HTTP StatusResponse
Upstream status{ "result": "<body.msg>" } for upstream validation failures
401{ "result": "User does not exist" } or auth validation message

Behavior/Processing

  • Calls the remote symbolication server key-check endpoint derived from server_url.
  • Uses sub-action in URL path (not a query action parameter).

Examples

Test symbolication API key

/o/symbolication/test_symbolication_key?server_url=https://symbolication.example.com&symb_key=SYMB_KEY_VALUE&api_key=YOUR_API_KEY

Last Updated

2026-04-13