Resource addresses
This section provides an overview of the structure and capabilities of the resource addresses provided by the Management API. For details on each resource address, see MarkLogic REST API Reference.
Resource addresses fall into the categories listed in the table below. The output from each type of resource address is described in Interpret the output.
Type of Resource Address |
Returns |
|---|---|
List |
A list of resources. For example, as list of the forests in the cluster:
|
Item |
A specific resource. For example, a specific forest in the cluster:
|
A resource address takes the form of a URL that includes a host name and a port number. The most basic resource address returns summary information for the entire cluster:
http://host:port/manage/LATEST/
The Management API version, LATEST in this release, is specified in every resource address to maintain compatibility with future revisions of the Management API.
You can optionally include the name of a resource and parameters in a resource address as follows:
http://host:port/manage/version/resource?param=value¶m=value