Loading TOC...

MarkLogic 12 Product Documentation
POST /manage/v2/hosts

Summary

This resource address is used to define a bootstrap host.

URL Parameters
format The format of the posted data. Can be either html, json, or xml (default). This value overrides the Accept header if both are present.
Request Headers
Accept The expected MIME type of the request body. 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.
Location If the request causes a restart, a Location header is included in the reponse. The header contains a path with which to construct a URL to usable to test when the restart has completed.

Response

Upon success, MarkLogic Server returns status code 201 (Created). If the host exists or 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

Usage Notes

The structure of the data in the request payload is as follows. Set bootstrap-host to true if it is to serve as the bootstrap host for the cluster; otherwise set to false. For details on the bootstrap host, see Database Replication in MarkLogic Server in the Database Replication Guide.

dynamic-host

host-name

The internet host name.

group

A group name or id.

bind-port

The distributed protocol server socket bind internet port number.

foreign-bind-port

The distributed protocol foreign server socket bind internet port number.

zone

Zone the host belongs to.

bootstrap-host

host-mode

The mode of this host

host-mode-description

The description for this host mode

Example


cat myHost.json
==> 

{
  "host-name": "hostname1",
  "group": "",
  "bind-port": 8090,
  "foreign-bind-port": 9091,
  "zone": "",
  "bootstrap-host": true
}

curl -X POST --digest -u admin:admin -H "Content-type: application/json" \
-d @myHost.json http://localhost:8002/manage/v2/hosts 

==>  Defines the host, named "hostname1," as the bootstrap host in 
     the cluster.

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