Loading TOC...

GET /manage/v2/databases/{id|name}/flexrep/properties

Summary

This resource address returns the inbound filter flexible replication properties for the database.

URL Parameters
format The format of the returned data. Can be either json or xml (default). This value overrides the Accept header if both are present.
Request Headers
Accept The expected MIME type of the response. If the format parameter is present, it takes precedence over the Accept header.
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 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. If the URI is malformed or the database doesn't exist, 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-user role, or the following privilege:

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

Usage Notes

The modifiable database properties are as follows. The alerting-uri property is optional.

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

inbound-filter-module

The name of a module to invoke as a filter.

inbound-filter-options

The options to use when invoking the filter module.

extusr:external-user

Example


http://localhost:8002/manage/v2/databases/Documents/flexrep/properties

==> Returns the flexible replication properties for the Documents database.
    

Comments

    Powered by MarkLogic Server 7.0-4.1 and rundmc | Terms of Use | Privacy Policy