The studioStartDebugMode Web API Method

Start debug mode on the target server.

Note that if this server is a member of a cluster, it will modify its own directive only and will not affect the rest of the cluster. When checking the cluster management UI, a notification may be displayed to show that this particular server deviates from the cluster blueprint of directive values, this is normal.

Version: 1.3

Required Permissions: Full

HTTP method: POST

Supported by Editions: Zend Server

Request Parameters:

Parameter

 Type

Required

Description

filters

array

Yes

Non empty array with filters

options

array

No

Debugging options

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

Response Format: Response successful message or error message

Possible Action Specific Error Codes: This action has no specific error codes.

Example

Usage Example

Request

POST /ZendServer/Api/studioStartDebugMode

Response

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

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

<requestData>

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

<method>studioStartDebugMode</method>

</requestData>

<responseData>

<debugMode>

<value>1</value>

<requiresRestart>1</requiresRestart>

</debugMode>

</responseData>

</zendServerAPIResponse>