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

Add documentation for API health endpoint
cloudflare · Nov 9, 2020 · 9ccff9a · 9ccff9a
2 parents 816bb92 + 7f46009
commit 9ccff9a
Showing 1 changed file with 14 additions and 0 deletions.
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