Skip to main content

System Utility - Stop Profiler

Endpoint​

/i/profiler/stop

Overview​

Stops profiler mode and finalizes profile files.

Authentication​

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

Permissions​

Requires Global Admin access.

Request Parameters​

ParameterTypeRequiredDescription
api_keyStringConditionalRequired if auth_token is not provided.
auth_tokenStringConditionalRequired if api_key is not provided.

Examples​

/i/profiler/stop?api_key=YOUR_API_KEY

Response​

Success Response​

{
  "result": "Stoping profiler for all processes"
}

Response Fields​

FieldTypeDescription
resultStringSuccess message when profiler is stopped.

Error Responses​

{
  "result": "Error: Profiler needs to be started"
}

Behavior​

  • Stops profiler and writes profiler artifacts under log profile directory.
Implementation details

Database Collections

This endpoint does not read or write database collections.