Web API Reference Guide > Available API Methods > Audit Methods > The auditSetSettings Method

The auditSetSettings Method

Save settings of audit history and triggers.

Version: 1.3

Required Permissions: Read-only

HTTP method: POST

Supported by Editions: All

Request Parameters:  

Parameter

 Type

Required

Description

email

string

No

Array of email value and array of audit types. Will be set to the an empty string if not passed.

callbackUrl

string

No

Array of URL value and array of audit types. Will be set to the an empty string if not passed.

history

integer

No

Number of saved days in history

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

Response Format: auditSettings

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

Example

Usage Example

Request

GET /ZendServer/Api/auditSetSettings

Response

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

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

<requestData>

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

<method>auditSetSettings</method>

</requestData>

<responseData>

<auditSettings>

<actions>

<action>

<type>send-mail</type>

<sendMailTo><![CDATA[Address]]></sendMailTo>

</action>

<action>

<type>send-url</type>

<sendToUrl><![CDATA[URL]]></sendToUrl>

</action>

</actions>

<history>30</history>

</auditSettings>

</responseData>

</zendServerAPIResponse>

 

Read Also

  Available API Methods    
  Audit Methods