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

README.md: Document contract api.

Browse source
This commit is contained in:
Henrik Hautakoski 2022-02-21 14:36:23 +01:00
parent b5c7b7c4d1
commit ec3a9bfac7
No known key found for this signature in database
GPG key ID: 608414D93E862CCD
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -39,12 +39,12 @@ 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 | api | Yes | Type of API to check against, `v1` = standard, `v2` = Hyperion |
| 2 | url | Yes (port default `80`) | http url to the api. `http(s)://<ip-or-domain>(:<port>)` |
| 3 | num_blocks | No (default `10`) | Number of blocks the api can drift before reported `down` |
| 4 | host | No (default from `url`) | Value to send in the `HTTP Host Header` to the API |
| # | Name | Required | Description |
| - | ---------- | ----------------------- | ----------------------------------------------------------------------------------------------- |
| 1 | api | Yes | Type of API to check against, `v1` = standard, `v2` = Hyperion, `contract` = eosio-contract-api |
| 2 | url | Yes (port default `80`) | http url to the api. `http(s)://<ip-or-domain>(:<port>)` |
| 3 | num_blocks | No (default `10`) | Number of blocks the api can drift before reported `down` |
| 4 | host | No (default from `url`) | Value to send in the `HTTP Host Header` to the API |
### Response