Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Add documentation for API health endpoint
- Loading branch information
1 parent
816bb92
commit 7f46009
Showing
1 changed file
with
14 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |