MarkLogic 10 Product Documentation
GET /manage/v2/properties

Summary

Retrieve the current properties of the cluster. For an example, see Coupling the Master and Replica Clusters in the Scripting Administrative Tasks Guide.

URL Parameters
format	The format of the returned data. Can be `json` or `xml` (default). If present, the `format` parameter overrides the Accept header.

Request Headers
Accept	The expected MIME type of the response. If the `format` parameter is present, it takes precedence over the Accept header. Allowed values: `application/xml`, `application/json`, and `text/html`.
Content-type	The MIME type of the data in the request body. The only supported value is `application/x-www-form-urlencoded`.

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 data in the response body contains the requested information.

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:

security-version

The security database version.

effective-version

The effective software version of this cluster.

cluster-id

The cluster ID.

cluster-name

The cluster name

ssl-fips-enabled

Whether or not SSL FIPS is enabled.

xdqp-ssl-certificate

The PEM encoded certificate for this cluster. If the 'file' attribute is present, it is a file containing the PEM encoded certificate.

bootstrap-hosts

The hosts that foreign clusters will use to bootstrap communication with this cluster.

This is a complex structure with the following children:

bootstrap-host

Information related to a particular foreign host.

This is a complex structure with the following children:

bootstrap-host-id: The ID of the host.
bootstrap-host-name: The name of the host.
bootstrap-connect-port: The distributed protocol client socket connect internet port number.

language-baseline

Overall language baseline configuration.

opsdirector-log-level

The minimum log level for log messages sent ops director. A value of 'disabled' disables all ops director log data.

opsdirector-metering

The type of metering data collected by Ops Director.

opsdirector-config

The type of configuration data collected by Ops Director.

opsdirector-session-endpoint

The REST URI for the Ops Director Session API endpoint.

fedramp

Whether MarkLogic is running in a FedRAMP environment.

data-directory

The data directory.

filesystem-directory

The filesystem directory.

role

The cluster role.

version

Version of cluster.

Example