Skip to main content

Test symbolication API key

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

/o/symbolication/test_symbolication_key

Overview

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

Authentication

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

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.

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

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

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