Loading TOC...

All REST Resources

109 resources
Resource URI Description
/manage/v1 (GET) This resource address returns summary information for the local cluster.
/manage/v1/clusters (GET) This resource address returns a list of all of the clusters coupled to the local cluster.
/manage/v1/clusters/{id|name} (GET) This resource address returns summary information for the specified foreign cluster.
/manage/v1/clusters/{id|name}/config (GET) This resource address returns configuration information for the specified foreign cluster.
/manage/v1/clusters/{id|name}/status (GET) This resource address returns status information for the specified foreign cluster.
/manage/v1/databases (GET) This resource address returns a summary of the databases in the cluster.
/manage/v1/databases/{id|name} (GET) This resource address returns information on the specified database.
/manage/v1/databases/{id|name}/{custom} (GET) This resource address returns some custom information for the specified database, as implemented by a specific plugin.
/manage/v1/databases/{id|name}/config (GET) This resource address returns the configuration information for the specified database.
/manage/v1/databases/{id|name}/counts (GET) This resource address returns the count information for the forests attached to the specified database.
/manage/v1/databases/{id|name}/edit (GET) This resource address returns the database configuration page in the Admin interface.
/manage/v1/databases/{id|name}/status (GET) This resource address returns status information for the specified database.
/manage/v1/forests (GET) This resource address returns a summary of the forests in the cluster.
/manage/v1/forests?view=schema (GET) This resource address returns a schema view of the forests in the cluster.
/manage/v1/forests?view=status (GET) This resource address returns a status view of the forests in the cluster.
/manage/v1/forests?view=storage (GET) This resource address returns a storage view of the forests in the cluster.
/manage/v1/forests/{id|name} (GET) This resource address returns information on a specific forest.
/manage/v1/forests/{id|name}/{custom} (GET) This resource address returns some custom information for the specified forest, as implemented by a specific plugin.
/manage/v1/forests/{id|name}/config (GET) This resource address returns the configuration information for the specified forest.
/manage/v1/forests/{id|name}/counts (GET) This resource address returns the count information for the specified forest.
/manage/v1/forests/{id|name}/edit (GET) This resource address returns the forest configuration page in the Admin Interface.
/manage/v1/forests/{id|name}/status (GET) This resource address returns the status of the specified forest.
/manage/v1/groups (GET) This resource address returns a summary of the groups in the cluster.
/manage/v1/groups/{id|name} (GET) This resource address returns information on the specified group.
/manage/v1/groups/{id|name}/{custom} (GET) This resource address returns some custom information for the specified group, as implemented by a specific plugin.
/manage/v1/groups/{id|name}/config (GET) This resource address returns the configuration information for the specified group.
/manage/v1/groups/{id|name}/counts (GET) This resource address returns the count information for the specified group.
/manage/v1/groups/{id|name}/edit (GET) This resource address returns the group configuration page in the Admin Interface.
/manage/v1/groups/{id|name}/status (GET) This resource address returns status information for the specified group.
/manage/v1/hosts (GET) This resource address returns a summary of the hosts in the cluster.
/manage/v1/hosts?view=status (GET) This resource address returns a status summary of the hosts in the cluster.
/manage/v1/hosts/{id|name} (GET) This resource address returns information on a specific host.
/manage/v1/hosts/{id|name}/{custom} (GET) This resource address returns some custom information for the specified host, as implemented by a specific plugin.
/manage/v1/hosts/{id|name}/config (GET) This resource address returns the configuration information for the specified host.
/manage/v1/hosts/{id|name}/counts (GET) This resource address returns the count information for the specified host.
/manage/v1/hosts/{id|name}/edit (GET) This resource address returns the host configuration page in the Admin Interface.
/manage/v1/hosts/{id|name}/status (GET) This resource address returns status information for the specified host.
/manage/v1/list/package (GET) This resource address returns configuration information for the specified App Servers and/or databases.
/manage/v1/package/compare (GET) This resource address is used in a POST request to import a packaged configuaration for resources to a host and compare it against the configurations of the host's local resources.
/manage/v1/package/install (POST) This resource address is used in a POST request to install a packaged configuration on the local host.
/manage/v1/query (GET) This resource address returns the summary of all of the resources in the local cluster.
/manage/v1/requests (GET) This resource address returns a summary of the requests in the cluster.
/manage/v1/requests/{id|uri} (GET) This resource address returns information on the specified request.
/manage/v1/servers (GET) This resource address returns a summary of the servers in the cluster.
/manage/v1/servers?view=status (GET) This resource address returns a status summary of the servers in the cluster.
/manage/v1/servers/{id|name}?group-id={id|name} (GET) This resource address returns information on the specified server.
/manage/v1/servers/{id|name}/{custom}?group-id={id|name} (GET) This resource address returns some custom information for the specified server, as implemented by a specific plugin.
/manage/v1/servers/{id|name}/config?group-id={id|name} (GET) This resource address returns configuration information for the specified server.
/manage/v1/servers/{id|name}/edit?group-id={id|name} (GET) This resource address returns the server configuration page in the Admin Interface.
/manage/v1/servers/{id|name}/status?group-id={id|name} (GET) This resource address returns status information for the specified server.
/manage/v1/status (GET) This resource address returns the aggregate status of the local cluster.
/manage/v1/tickets/ticket/{ticket-number}/revert (POST) Each /manage/v1/package/install resource address returns ticket number.
/manage/v1/transactions (GET) This resource address returns a summary of the transactions in the cluster.
/manage/v1/transactions/{id|uri}?host-id={id|name} (GET) This resource address returns information on the specified transaction.
/v1/config/indexes (GET) Request a report on whether or not the database configuration includes index configurations that satisfy all installed query options.
/v1/config/indexes/{name} (GET) Request a report on whether or not the database configuration includes index configurations that satisfy these named query options.
/v1/config/namespaces (DELETE) Remove all installed namespace bindings.
/v1/config/namespaces (GET) List all namespace bindings configured for use in queries, ordered alphabetically by prefix.
/v1/config/namespaces (POST) Create or append to namespace bindings that can be used in subsequent query operations.
/v1/config/namespaces (PUT) Create or replace namespace bindings that can be used in subsequent query operations.
/v1/config/namespaces/{prefix} (DELETE) Remove the namespace binding for {prefix}.
/v1/config/namespaces/{prefix} (GET) Retrieve the namespace URI associated with the REST service namespace binding prefix {prefix}.
/v1/config/namespaces/{prefix} (PUT) Create or modify a namespace binding.
/v1/config/properties (DELETE) Reset all MarkLogic REST API instance configuration properties to their default values.
/v1/config/properties (GET) Retrieve a list of all MarkLogic REST API instance configuration properties names and settings.
/v1/config/properties (PUT) Set or modify MarkLogic REST API instance configuration properties.
/v1/config/properties/{name-property} (DELETE) Reset the MarkLogic REST API instance configuration property {property-name} to its default value.
/v1/config/properties/{property-name} (GET) Retrieve the value of the MarkLogic REST API instance configuration property named by {property-name}.
/v1/config/properties/{property-name} (PUT) Set the value of the MarkLogic REST API instance configuration property named by {property-name}.
/v1/config/query (DELETE) Remove all named query options.
/v1/config/query (GET) Retrieve a list of all the named query options available for use with the service.
/v1/config/query/(default|{name}) (DELETE) Remove the named (or default) query options from the App Server.
/v1/config/query/(default|{name}) (GET) Retrieve the query options whose name matches the name in the request URI, or retrieve the default query options.
/v1/config/query/(default|{name}) (POST) Create or append to named query options.
/v1/config/query/(default|{name}) (PUT) Create or replace named query options.
/v1/config/query/(default|{name})/{child-element} (DELETE) Remove an option setting from the named query options.
/v1/config/query/(default|{name})/{child-element} (GET) Retrieve the setting for a particular option in named query options.
/v1/config/query/(default|{name})/{child-element} (POST) Add options to existing named query options, or create new named query options if {name} does not already exist.
/v1/config/query/(default|{name})/{child-element} (PUT) Replace options in existing named query options, or create new named query options if {name} does not already exist.
/v1/config/resources (GET) Retrieve a list of installed resource service extensions, including their metadata.
/v1/config/resources/{name} (DELETE) Uninstall the named resource service extension.
/v1/config/resources/{name} (GET) Retrieve the XQuery library module implementing the named resource service extension.
/v1/config/resources/{name} (PUT) Create or update a resource service extension.
/v1/config/transforms (GET) Retrieve metadata about all transforms installed using the /v1/config/transforms/{name} endpoint.
/v1/config/transforms/{name} (DELETE) Remove the named transform.
/v1/config/transforms/{name} (GET) Retrieve the XQuery or XSLT implementation installed for the named transform.
/v1/config/transforms/{name} (PUT) Create or update the named transform.
/v1/documents (DELETE) Remove a document, or reset document metadata.
/v1/documents (GET) Retrieve document content and/or metadata from the database.
/v1/documents (HEAD) Returns the same headers as an equivalent GET (content/metadata fetch) on the /documents endpoint.
/v1/documents (PUT) Insert or update document contents and/or metadata, at a caller-supplied document URI.
/v1/keyvalue (GET) Query the database based on the value of a JSON key, XML element, or XML element attribute.
/v1/resources/{name} (DELETE) Send a DELETE request to the named resource service extension.
/v1/resources/{name} (GET) Make a GET request to the named resource service extension.
/v1/resources/{name} (POST) Applies an extension-specific operation to a resource implemented by a resource service extension.
/v1/resources/{name} (PUT) Perform the PUT operation associated with a resource service extension.
/v1/rest-apis (GET) Retrieve a list of REST API instances, including configuration details.
/v1/rest-apis (POST) Create an instance of the MarkLogic REST API, including an HTTP app server, required modules, and optionally a content database.
/v1/rest-apis/{name} (DELETE) Remove an HTTP App Server servicing the MarkLogic REST API.
/v1/rest-apis/{name} (GET) Retrieve configuration information about an App Server servicing the MarkLogic REST API.
/v1/search (DELETE) Remove documents in a collection or directory, or clear the database.
/v1/search (GET) Search the database using a string and/or structured query.
/v1/search (POST) Search the database using a structured query, supplied in the POST body; or search the database using a string or structured query with the query options and query combined in the POST body.
/v1/transactions (POST) Create a multi-statement transaction.
/v1/transactions/{txid} (GET) Retrieve status information for the transaction whose id matches the txid given in the request URI.
/v1/transactions/{txid} (POST) Commit or rollback the transaction whose id matches the txid given in the request URI.
/v1/values (GET) Retrieve a list of lexicon configurations available for use with GET /v1/values/{name}.
/v1/values/{name} (GET) Query the values in a lexicon or range index, or find co-occurrences of values in multiple rang indexes.
/v1/values/{name} (POST) Query the values in a lexicon or range index, or find co-occurrences of values in multiple rang indexes.