You are currently viewing Zend Server 5.x documentation. Click here to view the latest Zend Server online documentation.
You are currently viewing Zend Server 5.x documentation. Click here to view the latest Zend Server online documentation.Start a debug session for a specific issue.
Required Permissions: Full
HTTP method: POST
Supported Editions: Zend Server, Zend Server Cluster Manager
Request parameters:
|
Parameter |
Type |
Required |
Description |
|
eventsGroupId |
String |
Yes |
The issue event group identifier |
|
noRemote			 |
Boolean |
No |
Use server's own local files for debug display. Default: true. Setting to false will use local files from studio if available |
|
overrideHost		 |
String |
No	 |
Override the host address sent to Zend Server for initiating a Debug session. This is used to point Zend Server at the right address where Studio is executed |
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: Request: POST /ZendServerManager/Api/studioStartDebug Content-type: application/x-www-form-urlencoded eventsGroupId=36
Response: <?xml version="1.0" encoding="UTF-8"?> <zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.1"> <requestData> <apiKeyName><![CDATA[Admin]]></apiKeyName> <method>studioStartDebug</method> </requestData> <responseData> <debugRequest> <success>1</success> <message>Debug session completed successfully</message> </debugRequest> </responseData> </zendServerAPIResponse> |
|
|
|
|
|
|
|
|
Related Links: Available API Methods |
|
|
|
© 1999-2013 Zend Technologies, Ltd. All rights reserved.
