Fetch Telemetry Configuration

Fetches the telemetry configuration. For more information on the telemetry topic, visit the Telemetry page.

Method

GET /telemetry/configuration

Parameters

This method takes no parameters.

Result

A JSON object containing configuration properties of the telemetry of the Rest API.

Name Value Description
enableTelemetry Boolean Specifies if the telemetry is configured or not. Values:
  • null - sending telemetry is not configured, no data will be sent
  • true - sending telemetry is enabled
  • false - sending telemetry is disabled

Response Codes

Code Media type Description
200 application/json Request successful.
401 application/json If the user who perform the operation is not a camunda-admin user.

Example

Request

GET /telemetry/configuration

Response

{
  "enableTelemetry": false
}

On this Page: