Loading TOC...

MarkLogic 12 Product Documentation
PUT /manage/v2/properties

Summary

This resource address modifies the properties of the local cluster.

URL Parameters
format The format of the returned data. Can be either json or xml (default). This parameter overrides the Accept header if both are present.
Request Headers
Accept The expected MIME type of the returned data. If the format parameter is present, it takes precedence over the Accept header.
Content-type The MIME type of the data in the request body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or 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 204 (No content). If the payload is malformed, a status code of 400 (Bad Request) is returned. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

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

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

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

Usage Notes

The modifiable cluster properties are as follows.

Note: The properties described here are for XML payloads. In general they are the same for JSON, with the exception that, in JSON, bootstrap-hosts is expressed in singular form. For example, in JSON, bootstrap-hosts is instead bootstrap-host and the format is as shown in the example below.

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

DEPRECATED

opsdirector-metering

DEPRECATED

opsdirector-config

DEPRECATED

opsdirector-session-endpoint

DEPRECATED

fedramp

Whether MarkLogic is running in a FedRAMP environment.

cluster-token-allow-list

Specifies which API tokens are allowed to invoke which endpoint URL.

This is a complex structure with the following children:

token-endpoint

Specifies which API tokens are allowed to invoke which endpoint URL.

This is a complex structure with the following children:

token-type

The type for the corresponding API token.

endpoint-url

The endpoint that the corresponding API token can invoke.

token-role

The endpoint that the corresponding API token can invoke.

data-directory

The data directory.

filesystem-directory

The filesystem directory.

role

The cluster role.

version

Version of cluster.

Example


curl -X PUT --anyauth -u admin:admin --header "Content-Type:application/json" \
-d '{"bootstrap-host": [{
            "bootstrap-host-id": "3543728720765551570",
            "bootstrap-host-name": "localhost",
            "bootstrap-connect-port": 7998}]}' \
http://localhost:8002/manage/v2/properties

==>  Sets "localhost" to be the bootstrap host for the cluster.

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.