The auditGetList Web API Method

Get a list of audit entries.

Version: 1.3

Required Permissions: Read-only

HTTP method: GET

Supported by Editions: All

Request Parameters:  

Parameter

 Type

Required

Description

limit

integer

No

The number of rows to retrieve. Default lists all audit entries up to an arbitrary limit set by the system

offset

integer

No

A paging offset to begin the list from. Default: 0

order

string

No

Column identifier for sorting the result set (audit_id, node_id, time). Default: audit_id

direction

string

No

Sorting direction: ASC or DESC. Default: DESC

filters

array

No

Add filter parameters in an ad-hoc manner. These filters will be added to the predefined filter that was passed. This parameter is an array with a predefined set of parameters that accept strings or arrays to hold multiple values:

from: string, a timestamp to use for retrieving audit rows

to: string, a timestamp to use for retrieving audit rows

freeText: string

auditGroups: array, a list of auditGroups-

  • AUDIT_GROUP_DEPLOYMENT
  • AUDIT_GROUP_CONFIGURATION
  • AUDIT_GROUP_RESTART
  • AUDIT_GROUP_SETTINGS_CHANGES
  • AUDIT_GROUP_AUTHENTICATION
  • AUDIT_GROUP_AUTHORIZATION
  • AUDIT_GROUP_BOOTSTRAP
  • AUDIT_GROUP_CLUSTER_MANAGEMENT
  • AUDIT_GROUP_CODETRACING
  • AUDIT_GROUP_MONITOR
  • AUDIT_GROUP_STUDIO
  • AUDIT_GROUP_CLEAR_CACHE
  • AUDIT_GROUP_PAGE_CACHE_RULES
  • AUDIT_GROUP_JOBQUEUE_RULES
  • AUDIT_GROUP_PHPINFO
  • AUDIT_GROUP_WEBAPI
  • AUDIT_GROUP_LICENSE

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

Response Format: auditList

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

Example

Usage Example

Request

GET /ZendServer/Api/auditGetList

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
	<requestData>
		<apiKeyName><![CDATA[Admin]]></apiKeyName>
		<method>auditGetList</method>
	</requestData>
	<responseData>
		<auditMessages>
			<auditMessage>
				<id>1</id>
				<username><![CDATA[admin]]</username>
				<requestInterface>webAPI</requestInterface>
				<remoteAddr>192.168.10.10</remoteAddr>
				<auditType>AUDIT_APPLICATION_DEPLOY</auditType>
			<auditTypeTranslated><![CDATA[.]]></auditTypeTranslated>
				<baseUrl>![CDATA[http://192.168.10.1/mtrig]]</baseUrl>
				<creationTime>2012-06-19T08:16:16</creationTime>
				<extraData></extraData>
				<outcome>OK</outcome>
			</auditMessage>
			<auditMessage>
				<id>2</id>
				<username><![CDATA[admin]]</username>
				<requestInterface>webAPI</requestInterface>
				<remoteAddr>192.168.10.11</remoteAddr>
				<auditType>AUDIT_DIRECTIVES_MODIFIED</auditType>
			<auditTypeTranslated><![CDATA[.]]></auditTypeTranslated>
				<baseUrl>![CDATA[]]</baseUrl>
				<creationTime>2012-06-19T08:18:25</creationTime>
				<extraData>
					<extraDataMessage>
						<parameter>
							<name>name</name>
							<value>session.cache_expire</value>
						</parameter>
						<parameter>
							<name>oldValue</name>
							<value>180</value>
						</parameter>
						<parameter>
							<name>newValue</name>
							<value>181</value>
						</parameter>
					</extraDataMessage>
					<extraDataMessage>
						<parameter>
							<name>name</name>
							<value>session.gc_divisor</value>
						</parameter>
						<parameter>
							<name>oldValue</name>
							<value>1000</value>
						</parameter>
						<parameter>
							<name>newValue</name>
							<value>1001</value>
						</parameter>
					</extraDataMessage>
				</extraData>
				<outcome>OK</outcome>
			</auditMessage>
		</auditMessages>
		<totalCount>2</totalCount>
	</responseData>
</zendServerAPIResponse>