Loading TOC...

MarkLogic 12 Product Documentation
Management API (Clusters)

For the complete list of REST resources in this category, refer to the main Management API page.

23 resources
Resource URI Description
/manage/v2 (GET) This resource address returns summary information for the local cluster.
/manage/v2 (POST) This resource address restarts and upgrades the local cluster.
/manage/v2?view=describe (GET) This resource address returns a description of the methods available on this endpoint.
/manage/v2?view=healthcheck (GET) This resource address returns a health check status for the local cluster.
/manage/v2?view=query (GET) This resource address returns the summary of all of the resources in the local cluster, or resources in the local cluster that match a query.
/manage/v2?view=status (GET) This resource address returns a status summary for the local cluster.
/manage/v2/clusters (GET) This resource address returns a list of all of the foreign clusters coupled to the local cluster.
/manage/v2/clusters (POST) This resource address creates a foreign cluster.
/manage/v2/clusters?view=metrics (GET) Retrieve historical monitoring data for the foreign clusters coupled to the local cluster.
/manage/v2/clusters/{id|name} (DELETE) This resource address deletes the specified foreign cluster.
/manage/v2/clusters/{id|name} (GET) This resource address returns summary information for the specified foreign cluster.
/manage/v2/clusters/{id|name} (POST) Initiate a state change on the named cluster, such as a shutdown or restart.
/manage/v2/clusters/{id|name}?view=metrics (GET) Retrieve historical monitoring data for the specified foreign cluster.
/manage/v2/clusters/{id|name}?view=status (GET) This resource address returns a status summary for the specified foreign cluster.
/manage/v2/clusters/{id|name}/dynamic-host-token (DELETE) This resource revokes a dynamic host token.
/manage/v2/clusters/{id|name}/dynamic-host-token (GET) This resource searches dynamic host tokens.
/manage/v2/clusters/{id|name}/dynamic-host-token (POST) This resource creates a dynamic host token that can be used to initialize dynamic hosts.
/manage/v2/clusters/{id|name}/dynamic-hosts (DELETE) This resource permanently removes a list of dynamic hosts from the cluster.
/manage/v2/clusters/{id|name}/dynamic-hosts (GET) This resource returns all dynamic hosts in this cluster.
/manage/v2/clusters/{id|name}/properties (GET) This resource address returns the modifiable properties of the named foreign cluster.
/manage/v2/clusters/{id|name}/properties (PUT) This resource address modifies the properties of the named foreign cluster.
/manage/v2/properties (GET) Retrieve the current properties of the cluster.
/manage/v2/properties (PUT) This resource address modifies the properties of the local cluster.