[couchdb-documentation] 01/01: Document /_up endpoint

[wo...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

wohali pushed a commit to branch 207-up
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git

commit bccc0108ee6512e3926d5be9c329f9d98c64414e
Author: Joan Touzet <jo...@atypical.net>
AuthorDate: Sat Mar 17 01:04:23 2018 -0400

    Document /_up endpoint
---
 src/api/server/common.rst | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/src/api/server/common.rst b/src/api/server/common.rst
index e0c0963..7091d81 100644
--- a/src/api/server/common.rst
+++ b/src/api/server/common.rst
@@ -1452,6 +1452,41 @@ is as follows:
     :>header Last-Modified: Static files modification timestamp
     :code 200: Request completed successfully
 
+.. _api/server/up:
+
+========
+``/_up``
+========
+
+.. versionadded:: 2.0
+
+.. http:get:: /_up
+    :synopsis: Health check endpoint
+
+    Confirms that the server is up, running, and ready to respond to requests.
+    If the server is in ``true`` or ``nolb``
+    :config:option:`maintenance_mode <couchdb/maintenance_mode>`, the endpoint
+    will return a 404 response.
+
+    :>header Content-Type: :mimetype:`application/json`
+    :code 200: Request completed successfully
+    :code 404: The server is unavaialble for requests at this time.
+
+    **Response**:
+
+    .. code-block:: http
+
+        HTTP/1.1 200 OK
+        Cache-Control: must-revalidate
+        Content-Length: 16
+        Content-Type: application/json
+        Date: Sat, 17 Mar 2018 04:46:26 GMT
+        Server: CouchDB/2.2.0-f999071ec (Erlang OTP/19)
+        X-Couch-Request-ID: c57a3b2787
+        X-CouchDB-Body-Time: 0
+
+        {"status":"ok"}
+
 .. _api/server/uuids:
 
 ===========

-- 
To stop receiving notification emails like this one, please contact
wohali@apache.org.