The codetracingDelete Web API Method

Delete a code-tracing file entry.

This action was changed in version 1.7 to send a delete request which is only accepted, not immediately executed. Client should poll on the codetracingList and tasksComplete webapi actions to track deletion progress.

Version: 1.2

Required Permissions: Full

HTTP method: POST

Supported Editions: Zend Server

Request parameters:

Parameter	Type	Required	Description
traceFile	String or array	Yes	Trace file identifier or a list of Trace file identifiers. The option to pass an array was added in version 1.3.
force	Boolean	No	Force remove code traces. Default is false. When set to true, the action won’t fail when encountering non existing traces. From version 1.9

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

Response Format: Details of the trace-file entry that was deleted <or> an error message if the operation failed

Possible Action Specific Error Codes:

HTTP Code	Error Code	Description
500	internalServerError	The code tracing action failed
404	noSuchTrace	The requested trace could not be found

Example

Usage Example

Request

Post /ZendServer/Api/codetracingDelete

traceFile=1.123.5

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
    <requestData>
           <apiKeyName><![CDATA[Admin]]></apiKeyName>
           <method>codetracingDelete</method>
    </requestData>
    <responseData>
           <codeTrace>
               <id>1.123.5</id>
               <date>123412341234</date>
               <url>http://localhost/test.php</url>
               <createdBy>Monitor Event</createdBy>
               <fileSize>12341234</fileSize>
               <applicationId>1</applicationId>
           </codeTrace>
     </responseData>
<zendServerAPIResponse>