Loading TOC...

GET /manage/v2/packages/{pkgname}/servers/{name}

Summary

This resource address returns configuration for the named server (name) in the named package (pkgname).

URL Parameters
group-id={group-id} The name or ID of the group containing the named server. This parameter is required.
format The format of the returned server configuration. This can be either xml or json. By default, the format is xml.
modules Whether or not the modules associated with the server are stored in the package. Set to true to package the server modules, or false not to package the modules.
Request Headers
Accept The expected MIME type of the response. If the format parameter is present, it takes precedence over the Accept header.
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, either application/xml or application/json.

Response

Upon success, MarkLogic Server returns status code 200 (OK). The response body contains the requested server configuration.

Required Privileges

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

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

Example

 
     http://localhost:8002/manage/v2/packages/test-package/servers/Oscars

     ==> Returns the XML configuration of the 'Oscars' server from the
         package, "test-package." 

    

Comments

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