Skip to content

Commit 7f46009

Browse files
committed
Add documentation for API health endpoint
1 parent 816bb92 commit 7f46009

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

doc/api/endpoint_health.txt

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
THE HEALTH ENDPOINT
2+
3+
Endpoint: /api/v1/cfssl/health
4+
Method: GET
5+
6+
Result:
7+
8+
The returned result is a JSON object with a single key:
9+
10+
* healthy: a bool indicating if the API server is healthy
11+
12+
Example:
13+
14+
$ curl ${CFSSL_HOST}/api/v1/cfssl/health

0 commit comments

Comments
 (0)