Web API Reference Guide > Available API Methods > Server and Cluster Management Methods > The logsGetLogfile Method

The logsGetLogfile Method

Retrieve the entire log file from the server or a remove cluster member.

Version: 1.3

Required Permissions: Read-Only

HTTP method: GET

Supported by Editions: All

Request Parameters:

Parameter

Type

Required

Description

logName

String

Yes

One of the following values:

codetracing, datacache, deployment, dserver, jobqueue, jqd, monitor, monitor_node, monitor_ui, pagecache, php, sc, scd, statistics, utils, zdd, zem, zsd, php

serverId

Integer

If passed, the log contents will be fetched from that cluster member, otherwise performed locally.

Expected Response Code: 200 OK.

Response Format: Application .zip file containing the retrieved log file.

Possible Action Specific Error Codes:

HTTP Code	Error Code	Description
400	invalidParameter	Could be as of non-recognized logName, non-existent serverId etc.
404	logFileNotReadable	Log file was not found / missing read permissions
500	internalServerError	Operation against remote server failed.

Example

Usage Example

Request (headers removed for the purpose of clarity)

GET /ZendServer/Api/logsGetLogfile?logname=zdd

Response (not all headers are shown)

HTTP/1.0 200 OK

… reponse body

	Read Also
	Available API Methods
	Server and Cluster Management Methods