The codetracingEnable Web API Method

Enables the special 'zend_monitor.event_generate_trace_file' and 'zend.monitor_generate_unique_events' directives.

Version: 1.2

Required Permissions: Full

HTTP method: POST

Supported by Editions: Zend Server

Request Parameters:

Parameter

 Type

Required

Description

restartNow

Boolean

No

Perform a php restart as part of applying the new settings, defaults to true

Expected Response Code: 200 OK, 202 Accepted. For more information see Response Format.

Response Format: The new code tracing directive's state.

Possible Action Specific Error Codes:

HTTP Code

Error Code

Description

500

internalServerError

The code tracing action failed

Example

Usage Example

Request

Post /ZendServer/Api/codetracingEnable

Response

<?xml version="1.0" encoding="UTF-8"?>

<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">

    <requestData>

           <apiKeyName><![CDATA[Admin]]></apiKeyName>

           <method>codetracingEnable</method>

    </requestData>

    <responseData>

           <codeTracingStatus>

               <componentStatus>Active</componentStatus>

               <traceEnabled>1</traceEnabled>

               <developerMode>1</developerMode>

               <awaitsRestart>0</awaitsRestart>

           </codeTracingStatus>

     </responseData>

<zendServerAPIResponse>