This guide describes how to use the administration APIs to create scripts that configure and manage the operation of MarkLogic Server on your system. This guide is intended for a technical audience, specifically the system administrator in charge of MarkLogic Server.
|Admin (xdmp:)||This API provides functions for database and forest maintenance and file system access.|
|Security (xdmp:)||This API provides functions for getting information on users, roles, and document access permissions.|
|Library Module Functions|
|Admin (admin:)||This API provides functions for creating, configuring, and deleting forests, databases, hosts, groups, and App Servers. Specific usage information for this API is provided in the next chapter, Using the Admin API.|
|Security (sec:)||This API provides functions for creating, configuring, and deleting users, roles, amps, and privileges.|
|PKI (pki:)||This API provides functions for creating, configuring, and deleting the SSL objects used for secure access to App Servers.|
The chapters Server Configuration Scripts, Sample Configuration Program, and Server Maintenance Operations provide code samples that demonstrate the various uses of the MarkLogic Server Administration APIs.
The Using the Admin API chapter describes the fundamentals of using the Admin and other APIs that allow you to perform administrative operations on MarkLogic Server.
The Server Configuration Scripts chapter demonstrates how to write simple scripts that create and configure MarkLogic Server objects.
The Sample Configuration Program chapter describes the modules that make up the Sample Configuration Program, which creates an entire configuration that supports the Oscars Explorer application described in Using the Oscars Sample Application in the Application Builder Developer's Guide.
The Server Maintenance Operations chapter describes how to write scripts to monitor and manage an existing MarkLogic Server configuration.