Merge pull request #1145 from AshleyPoole/ash/add-health-api-doc

nickysemenza · web-flow · commit 9ccff9a3f533 · 2020-11-09T12:37:41.000-08:00
Add documentation for API health endpoint
diff --git a/doc/api/endpoint_health.txt b/doc/api/endpoint_health.txt
@@ -0,0 +1,14 @@
+THE HEALTH ENDPOINT
+
+Endpoint: /api/v1/cfssl/health
+Method:   GET
+
+Result:
+
+    The returned result is a JSON object with a single key:
+
+    * healthy: a bool indicating if the API server is healthy
+
+Example:
+
+    $ curl ${CFSSL_HOST}/api/v1/cfssl/health
