diff --git a/website/content/api-docs/health.mdx b/website/content/api-docs/health.mdx index fcda3cbcab..898c8ffe41 100644 --- a/website/content/api-docs/health.mdx +++ b/website/content/api-docs/health.mdx @@ -235,7 +235,7 @@ The table below shows this endpoint's support for - `near` `(string: "")` - Specifies a node name to sort the node list in ascending order based on the estimated round trip time from that node. Passing `?near=_agent` uses the agent's node for the sort. - **Note** that using `near` will ignore + ~> **Note:** Using `near` will ignore [`use_streaming_backend`](/docs/agent/config/config-files#use_streaming_backend) and always use blocking queries, because the data required to sort the results is not available to the streaming backend. @@ -259,6 +259,8 @@ The table below shows this endpoint's support for - `filter` `(string: "")` - Specifies the expression used to filter the queries results prior to returning the data. +- `peer` `(string: "")` - Specifies the imported service's peer. Applies only to imported services. + - `ns` `(string: "")` - Specifies the namespace of the service. You can also [specify the namespace through other methods](#methods-to-specify-namespace). @@ -431,8 +433,8 @@ gateway](/docs/connect/gateways/ingress-gateway) for a service in a given datace Parameters and response format are the same as [`/health/service/:service`](/api-docs/health#list-nodes-for-service). -**Note** that unlike `/health/connect/:service` and `/health/service/:service` this -endpoint does not support the [streaming backend](/api-docs/features/blocking#streaming-backend). +~> **Note:** Unlike `/health/connect/:service` and `/health/service/:service` this +endpoint does not support the `peer` query parameter and the [streaming backend](/api-docs/features/blocking#streaming-backend). ## List Checks in State