eosswedenorg/antelope-api-healthcheck
1
0
Fork 0
mirror of https://github.com/eosswedenorg/antelope-api-healthcheck synced 2026-06-18 05:00:03 +02:00
Code Releases Activity

README.md: Correcting+Cleanup request parameters documentation.

Browse source
This commit is contained in:
Henrik Hautakoski 2020-06-23 13:30:03 +02:00
parent a310cb041d
commit 5481dd7d32
1 changed files with 5 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -17,12 +17,11 @@ The protocol is simple and has 4 rules.
The following parameters are supported in a request and are ordered from
first to last below:
| # | Name | Required | Description |
| - | ---------- | -------- | ----------------------------------------------------------------------------- |
| 1 | Host | Yes | IP/Hostname to the api. |
| 2 | Port | No | Port number to the api (default `80`) |
| 3 | num_blocks | No | Number of blocks the api can drift before reported `down` (default 10) |
| 4 | version | No | API Version to check against, `v1` = standard, `v2` = Hyperion (default `v1`) |
| # | Name | Required | Description |
| - | ---------- | ----------------------- | -------------------------------------------------------------- |
| 1 | url | Yes (port default `80`) | http url to the api. `http(s)://<ip-or-domain>(:<port>)` |
| 2 | num_blocks | No (default `10`) | Number of blocks the api can drift before reported `down` |
| 3 | version | No (default `v1`) | API Version to check against, `v1` = standard, `v2` = Hyperion |
### Response