luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

docs: add section for /health/ingress/:service API (#8108) 

* docs: add section for /health/ingress/:service API

* Add documentation around consul version for API

* docs: add note about gateway-services API release version
This commit is contained in:
Chris Piraino 2020-07-10 12:36:46 -05:00 committed by GitHub
parent 1e5212b257
commit 51f71d43ab
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
website/pages/api-docs/catalog.mdx
View File

@ -904,6 +904,8 @@ top level object. The following selectors and filter operations are supported:
## List Services for Gateway
-> **1.8.0+:** This API is available in Consul versions 1.8.0 and later.
This endpoint returns the services associated with an ingress gateway or terminating gateway.
| Method | Path | Produces |

14
website/pages/api-docs/health.mdx
View File

@ -403,6 +403,20 @@ so this endpoint may be used to filter only the Connect-capable endpoints.
Parameters and response format are the same as
[`/health/service/:service`](/api/health#list-nodes-for-service).
## List Nodes for Ingress Gateways Associated to a Service
-> **1.8.0+:** This API is available in Consul versions 1.8.0 and later.
This endpoint returns the nodes providing a [ingress
gateway](/docs/connect/ingress-gateway) for a service in a given datacenter.
| Method | Path | Produces |
| ------ | -------------------------- | ------------------ |
| `GET` | `/health/ingress/:service` | `application/json` |
Parameters and response format are the same as
[`/health/service/:service`](/api/health#list-nodes-for-service).
## List Checks in State
This endpoint returns the checks in the state provided on the path.