JSON API » traces » traces/stop

Sends a request to an Asterisk machine to stop any running trace. The actual stop up is asynchronous, and may take a second or two after the function returns. If no trace was running, this function has no effect.

Input parameters

Requires authentication and the system role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
machine	Integer	ID of machine to stop trace on.	Yes

Responses

Code	Description
204	Stop successfully requested. This code is returned even if no trace was running.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.

Data returned

No data is returned.

Example: With required parameters

http://enswitch.example.com/api/json/traces/stop/?auth_username=user;auth_password=password;machine=1

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
3.13	Function added.