status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: update register check docs (closes #6635) (#10261) 

Update register check documentation clarify that Id returns as CheckId in the response

Co-Authored-By: Shaker Islam <shaqq@users.noreply.github.com>

Co-authored-by: Shaker Islam <shaqq@users.noreply.github.com>
This commit is contained in:
Dhia Ayachi 2021-05-19 20:24:54 -04:00 committed by hc-github-team-consul-core
parent 510d81ac4d
commit 9c6a9f4add
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
website/content/api-docs/agent/check.mdx
View File

@ -108,7 +108,7 @@ The table below shows this endpoint's support for
- `ID` `(string: "")` - Specifies a unique ID for this check on the node. - `ID` `(string: "")` - Specifies a unique ID for this check on the node.
This defaults to the `"Name"` parameter, but it may be necessary to provide an This defaults to the `"Name"` parameter, but it may be necessary to provide an
ID for uniqueness. ID for uniqueness. This value will return in the response as `"CheckId"`.
- `Interval` `(string: "")` - Specifies the frequency at which to run this - `Interval` `(string: "")` - Specifies the frequency at which to run this
check. This is required for HTTP and TCP checks. check. This is required for HTTP and TCP checks.