From 7dc78b39c9c5f5120619e70ba168a2d5c12081f2 Mon Sep 17 00:00:00 2001 From: Dhia Ayachi Date: Wed, 19 May 2021 20:24:54 -0400 Subject: [PATCH] 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 Co-authored-by: Shaker Islam --- website/content/api-docs/agent/check.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/api-docs/agent/check.mdx b/website/content/api-docs/agent/check.mdx index 67819a944b..e332a435e0 100644 --- a/website/content/api-docs/agent/check.mdx +++ b/website/content/api-docs/agent/check.mdx @@ -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. 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 check. This is required for HTTP and TCP checks.