The Membase Management REST API provides an easy to use interface for controlling your Membase installation.
The Membase Management REST API provides the ability to manage a Membase Server deployment. It conforms to Representational State Transfer (REST) constraints (is a RESTful architecture). The Membase Management REST API is used to manage clusters, server nodes, and buckets, and to retrieve run-time statistics, within your Membase Server deployment.
The REST API is not used to directly manage
data in memory or on disk. The cache data management operations
(set and get, for example) are
handled by clients and the appropriate SDKs. See
Couchbase
SDKs.
The REST API makes use and reference to a number of different systems within the Membase Server product. For more information, read Section 4.3.1, “Key Concepts”.
The Membase Management REST API returns many responses in the JavaScript Object Notation (JSON). Some responses have an empty body, but indicate the response with standard HTTP codes. For more information, see RFC 4627 (http://www.ietf.org/rfc/rfc4627.txt) and www.json.org.
The Membase Management REST API uses HTTP basic authentication. The browser-based Section 4.1, “Membase Administration Web Console” and Section 4.2, “Membase Command-line Interface” also use HTTP basic authentication.
All server nodes in a cluster share the same properties and can handle any requests made via the Membase Management REST API. It does not matter which specific server node you communicate with via the API. If the server node cannot service a request directly (due to lack of access to state or some other information), it will forward the request to the appropriate server node, retrieve the results, and send the results back to the client.