GET /manage/v2/forests?view=metrics

Summary

Retrieve historical monitoring data about the forests in the cluster.

URL Parameters
format The format of the returned data. Can be either json, or xml. This value overrides the Accept header if both are present.
fullrefs If set to true, full detail is returned for all relationship references. A value of false (the default) indicates to return detail only for first references.
Request Headers
Accept The expected MIME type of the response. If the format parameter is present, it takes precedence over the Accept header. Supported values: application/xml, 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). The response body contains the requested data.

Required Privileges

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

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

Usage Notes

The structure of the output returned from this REST API is as follows:

meta

metrics-properties

metrics-relations

related-views

Example


http://localhost:8002/manage/v2/forests?view=metrics

==>  Returns historical monitoring data about the forests in the cluster. 
    
Powered by MarkLogic Server | Terms of Use | Privacy Policy