MarkLogic 12 Product Documentation
GET /manage/v2/logs

Summary

Returns the content of server log files.

URL Parameters
format The format of the data in the log file. The supported formats are json, xml, html or text.
filename The log file to be returned. If format=text, the log file is returned in plain text; for other formats, it is returned with appropriate scaffolding.
host The host from which to return the log data.
start The start time for the log data.
end The end time for the log data.
regex Filters the log data, based on a regular expression.
Request Headers
Accept The desired MIME type of the data in the response body. If the format parameter is present, it takes precedence over this header. Supported values: application/xml (default), application/json, text/html, and text/plain.
Response Headers
Content-type The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, text/html, or text/plain.

Response

Upon success, MarkLogic server returns status code 200 (OK) and the response body contains the requested data. A status code of 400 (Bad request) is returned if the request attempts to use the query parameters (start, end, or regex) against an access or audit log; queries are only supported against error logs. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges. A status code of 404 is returned if the specified filename is not a log file.

Required Privileges

This operation requires the manage-user role, or the following privilege:

http://marklogic.com/xdmp/privileges/manage

Example


http://localhost:8002/manage/v2/logs?filename=ErrorLog.txt

==>  Returns the ErrorLog.txt log in XML.
Powered by MarkLogic Server | Terms of Use | Privacy Policy