github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Backport of docs: Adds initial sg documentation for the health API into release 1.20.x (#21988) 

* Adds initial sg documentation for the health API  (#21763)

Adds initial sg documentation

* Backport of docs: Adds initial sg documentation for the health API

into release/1.20.x

---------

Co-authored-by: Nick Wales <588472+nickwales@users.noreply.github.com>
pull/22006/head
Aimee Ukasick 2024-12-04 11:43:18 -06:00 committed by GitHub
parent 297ca6b2f3
commit 5b91606d82
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
website/content/api-docs/health.mdx
View File

@ -222,7 +222,7 @@ The table below shows this endpoint's support for
| `YES` <sup>1</sup> | `all` | `background refresh` | `node:read,service:read` |
<p>
<sup>1</sup>some query parameters will use the <a href="/consul/api-docs/features/blocking#streaming-backend">streaming backend</a> for blocking queries.
<sup>1</sup>some query parameters will use the <a href="/consul/api-docs/features/blocking#streaming-backend">streaming backend</a> for blocking queries.
</p>
### Path Parameters
@ -265,14 +265,17 @@ The table below shows this endpoint's support for
- `merge-central-config` - Include this flag in a request for `connect-proxy` kind or `*-gateway` kind
services to return a fully resolved service definition that includes merged values from the
[proxy-defaults/global](/consul/docs/connect/config-entries/proxy-defaults) and
[proxy-defaults/global](/consul/docs/connect/config-entries/proxy-defaults) and
[service-defaults/:service](/consul/docs/connect/config-entries/service-defaults) config entries.
Returning a fully resolved service definition is useful when a service was registered using the
Returning a fully resolved service definition is useful when a service was registered using the
[/catalog/register](/consul/api-docs/catalog#register_entity) endpoint, which does not automatically merge config entries.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the service.
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
- `sg` `(string: "")` <EnterpriseAlert inline /> - Specifies the sameness group the service is a member of to
facilitate requests to identical services in other peers or partitions.
### Sample Request
```shell-session