Skip to main content

Administrating MarkLogic Server

/manage/v2/forests/{id|name}

Method

Description

Parameters

XQuery Equivalent

GET

Gets a summary of the forest.

format? (json | xml) view

admin:forest-get-*

POST

Initiates a state change on the forest.

state (clear | merge | restart | attach | detach | retire | employ)

xdmp:forest-clear

xdmp:merge

xdmp:forest-restart

admin:database-attach-forest

admin:database-detach-forest

admin:database-retire-forest

admin:database-employ-forest

DELETE

Deletes the forest.

level (config-only | full)

admin:forest-delete

For an example, see this topic: