From 7f460093583f10da924467345a42f48af6f2438b Mon Sep 17 00:00:00 2001
From: Ashley Poole <git@ashleypoole.co.uk>
Date: Sun, 8 Nov 2020 12:16:12 +0000
Subject: [PATCH] Add documentation for API health endpoint

---
 doc/api/endpoint_health.txt | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 doc/api/endpoint_health.txt

diff --git a/doc/api/endpoint_health.txt b/doc/api/endpoint_health.txt
new file mode 100644
index 000000000..72985d98e
--- /dev/null
+++ 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