bccd920db7
* updated docs - added docs for start command - deprecated running without a command - added instructions for autocomplete setup * addressed review comments * addressed review comments * addressed review comments * docs/nia: Terraform Cloud agent support - Add agent as a supported execution mode - Add terraform_cloud_workspace configuration - Deprecate existing terraform_version config * license block docs * added HCP Consul to compatibility * added HCP instructions * addressed review comments * added new auto-retrieval behavior to license docs * addressed review comments * addressed review comments * Apply suggestions from code review * Apply suggestions from code review * updated docs * updated docs * Apply suggestions from code review Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> * fixed heading types * fixed heading types * update docs * docs/nia: Add service registration configurations * docs/nia: Style guide updates * docs/nia: Update with beta docs feedback * docs/nia: Update license config formatting Other top-level blocks aren't included in the list of global config options, so removed the liciense entry. * docs/nia: Add auto-retrieval section to license page * docs/nia: Separate column for HCP Consul support * docs/nia: Compatiblity version upper bounds * docs/nia: Fix broken links * docs/nia: Style guide fixes Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Remove RequestId field from cts health api docs. * docs/nia - Update CTS service id format (#13125) * docs/nia: Convert Consul config to table format * docs/nia: Add ACL token policy requirements * update docs (#13174) * docs/nia: Fix ca_path, key default, and some links * docs/nia: Add CTS service address config * Update website/content/docs/nia/cli/index.mdx * docs/nia: update for 0.6 GA (#13191) Co-authored-by: devarshishah3 <devarshishah3@gmail.com> Co-authored-by: Michael Wilkerson <62034708+wilkermichael@users.noreply.github.com> Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> Co-authored-by: Melissa Kam <mkam@hashicorp.com> Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com> Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> Co-authored-by: Derek Menteer <derek.menteer@hashicorp.com> Co-authored-by: lornasong <lornasong@users.noreply.github.com> Co-authored-by: hashi-derek <105233703+hashi-derek@users.noreply.github.com> Co-authored-by: devarshishah3 <devarshishah3@gmail.com>
36 lines
905 B
Plaintext
36 lines
905 B
Plaintext
---
|
|
layout: docs
|
|
page_title: Consul-Terraform-Sync Health API
|
|
description: >-
|
|
Consul-Terraform-Sync Health API
|
|
---
|
|
|
|
# Health
|
|
|
|
The `/health` endpoint returns a successful response when Consul-Terraform-Sync (CTS) is available and running. Requests to this endpoint are not logged, which makes it suitable for health checks that constantly poll CTS.
|
|
|
|
| Method | Path | Produces |
|
|
| ------ | ------------------- | ------------------ |
|
|
| `GET` | `/health` | `application/json` |
|
|
|
|
### Response Statuses
|
|
|
|
| Status | Reason |
|
|
| ------ | ---------------------------------------------------- |
|
|
| 200 | CTS is healthy |
|
|
|
|
### Example
|
|
|
|
The following request makes a `GET` call to the `health` endpoint:
|
|
|
|
```shell-session
|
|
$ curl --request GET \
|
|
localhost:8558/v1/health
|
|
```
|
|
|
|
Response:
|
|
|
|
```json
|
|
{}
|
|
```
|