MarkLogic 9 Product Documentation
GET /manage/v2/logsSummary
Generates a support request, along with your system status.
URL Parameters |
format |
The format of the data in the log file. The
supported formats are json , xml or html . |
filename |
The log file to be returned. If
format=html , the log file is returned with HTML scaffolding; otherwise it is
returned as plain text, regardless of the format. If filename is not
specified, this endpoint fits into the general pattern of read-only config. In
particular, the format may be json, xml, or html.
|
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 . |
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 , or text/html .
|
Response
Upon success, MarkLogic server returns status code 200 (OK) and the response
body contains the requested data. 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-admin
role, or the following
privilege:
http://marklogic.com/xdmp/privileges/manage-admin
Example
http://localhost:8002/manage/v2/logs?filename=ErrorLog.txt
==> Returns the ErrorLog.txt log in plain text.
Copyright © 2024 MarkLogic Corporation. MARKLOGIC is a
registered trademark of MarkLogic Corporation.