Web API Reference Guide > Available API Methods > Monitor Methods > The getBacktraceFile Method

The getBacktraceFile Method

Retrieve an event’s backtrace file payload. The file is returned encoded in base64 to conserve the xml structure of the response and its internal information.

Version: 1.3

Required Permissions: Read-Only

HTTP method: GET

Supported by Editions: Zend Server, ZSCM

Request Parameters:

Parameter	Type	Required	Description
eventGroupId	Integer	Yes	Events group identifier, provided in the eventsGroup element.
backtraceNum	Integer	Yes	The backtrace step from the events group to be retrieved, used to choose which file to retrieve

Expected Response Code: 200 OK - Returned for successfully running a scheduled job. For more information see Response Format.

Response Format: Response successful message or error message

Possible Action Specific Error Codes: None.

Example

Usage Example

Request

GET /ZendServer/Api/monitorGetBacktraceFile?eventsGroupId=1&backtraceNum=0

Content-type: application/x-www-form-urlencoded

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
	<requestData>
		<apiKeyName><![CDATA[Admin]]></apiKeyName>
		<method>monitorGetBacktraceFile</method>
	</requestData>
	<responseData>
		<sourcePayload><![CDATA[....]]></sourcePayload>
		<highlightLine>10</highlightLine>
	</responseData>
</zendServerAPIResponse>

	Read Also
	Available API Methods
	Monitor Methods