mirror of https://github.com/status-im/consul.git
website: content updates for developer (#14419)
Co-authored-by: Ashlee Boyer <ashlee.boyer@hashicorp.com> Co-authored-by: Ashlee M Boyer <43934258+ashleemboyer@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@gmail.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> Co-authored-by: HashiBot <62622282+hashibot-web@users.noreply.github.com> Co-authored-by: Kevin Wang <kwangsan@gmail.com>
This commit is contained in:
Bryce Kalow
GitHub
parent
2721fc9a6e
commit
85c1a33c42
|
|
@ -13,7 +13,8 @@ DOCKER_RUN_FLAGS=-it \
|
|||
--volume "$(PWD)/redirects.js:/app/redirects.js" \
|
||||
--volume "next-dir:/app/website-preview/.next" \
|
||||
--volume "$(PWD)/.env:/app/.env" \
|
||||
-e "REPO=consul"
|
||||
-e "REPO=consul" \
|
||||
-e "PREVIEW_MODE=developer"
|
||||
|
||||
# Default: run this if working on the website locally to run in watch mode.
|
||||
.PHONY: website
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -159,7 +159,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -211,7 +211,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -350,7 +350,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -392,7 +392,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -157,7 +157,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -207,7 +207,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -345,7 +345,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -387,7 +387,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -99,7 +99,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -201,7 +201,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -250,7 +250,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -286,7 +286,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -381,7 +381,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -419,7 +419,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -502,7 +502,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -87,7 +87,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -141,7 +141,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -178,7 +178,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -227,7 +227,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -266,7 +266,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -105,7 +105,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -155,7 +155,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -205,7 +205,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -292,7 +292,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -334,7 +334,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -172,7 +172,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -242,7 +242,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -311,7 +311,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -435,7 +435,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -477,7 +477,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -172,7 +172,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -328,7 +328,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -383,7 +383,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -541,7 +541,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -626,7 +626,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -668,7 +668,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------------------ |
|
||||
|
|
@ -112,7 +112,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | -------------------------- |
|
||||
|
|
@ -314,7 +314,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | -------------------------- |
|
||||
|
|
@ -352,7 +352,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | -------------------------- |
|
||||
|
|
@ -391,7 +391,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | -------------------------- |
|
||||
|
|
@ -433,7 +433,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | -------------------------- |
|
||||
|
|
@ -475,7 +475,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | -------------------------- |
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | -------------------- | --------------- |
|
||||
|
|
@ -121,7 +121,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | -------------------- | ------------ |
|
||||
|
|
@ -189,7 +189,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | -------------------- | --------------- |
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | --------------- |
|
||||
|
|
@ -223,7 +223,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -291,7 +291,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -371,7 +371,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------- |
|
||||
|
|
@ -404,7 +404,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -463,7 +463,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -585,7 +585,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -630,7 +630,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------- |
|
||||
|
|
@ -672,7 +672,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------- |
|
||||
|
|
@ -711,7 +711,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ---------------- |
|
||||
|
|
@ -788,7 +788,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------- |
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | -------------- |
|
||||
|
|
@ -147,7 +147,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ----------------- | ----------------- | ------------- | -------------- |
|
||||
|
|
@ -251,7 +251,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | -------------- |
|
||||
|
|
@ -582,7 +582,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | --------------- |
|
||||
|
|
@ -758,7 +758,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | --------------- |
|
||||
|
|
@ -798,7 +798,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | --------------- |
|
||||
|
|
|
|||
|
|
@ -0,0 +1,161 @@
|
|||
---
|
||||
layout: api
|
||||
page_title: HTTP API
|
||||
description: |-
|
||||
Consul exposes a RESTful HTTP API to control almost every aspect of the
|
||||
Consul agent.
|
||||
---
|
||||
|
||||
# HTTP API Structure
|
||||
|
||||
The main interface to Consul is a RESTful HTTP API. The API can perform basic
|
||||
CRUD operations on nodes, services, checks, configuration, and more.
|
||||
|
||||
## Authentication
|
||||
|
||||
When authentication is enabled, a Consul token should be provided to API
|
||||
requests using the `X-Consul-Token` header or with the
|
||||
Bearer scheme in the authorization header.
|
||||
This reduces the probability of the
|
||||
token accidentally getting logged or exposed. When using authentication,
|
||||
clients should communicate via TLS.
|
||||
|
||||
If no token is provided for an HTTP request then Consul will use the default ACL token
|
||||
if it has been configured. If no default ACL token was configured then the anonymous
|
||||
token will be used.
|
||||
|
||||
Below is an example using `curl` with `X-Consul-Token`.
|
||||
|
||||
```shell-session
|
||||
$ curl \
|
||||
--header "X-Consul-Token: <consul token>" \
|
||||
http://127.0.0.1:8500/v1/agent/members
|
||||
```
|
||||
|
||||
Below is an example using `curl` with a [RFC6750](https://tools.ietf.org/html/rfc6750) Bearer token.
|
||||
|
||||
```shell-session
|
||||
$ curl \
|
||||
--header "Authorization: Bearer <consul token>" \
|
||||
http://127.0.0.1:8500/v1/agent/members
|
||||
```
|
||||
|
||||
Previously this was provided via a `?token=` query parameter. This functionality
|
||||
exists on many endpoints for backwards compatibility, but its use is **highly
|
||||
discouraged**, since it can show up in access logs as part of the URL.
|
||||
|
||||
To learn more about the ACL system read the [documentation](/docs/security/acl).
|
||||
|
||||
## Version Prefix
|
||||
|
||||
All API routes are prefixed with `/v1/`. This documentation is only for the v1 API.
|
||||
|
||||
## Formatted JSON Output
|
||||
|
||||
By default, the output of all HTTP API requests is minimized JSON. If the client
|
||||
passes `pretty` on the query string, formatted JSON will be returned.
|
||||
|
||||
## HTTP Methods
|
||||
|
||||
Consul's API aims to be RESTful, although there are some exceptions. The API
|
||||
responds to the standard HTTP verbs GET, PUT, and DELETE. Each API method will
|
||||
clearly document the verb(s) it responds to and the generated response. The same
|
||||
path with different verbs may trigger different behavior. For example:
|
||||
|
||||
```text
|
||||
PUT /v1/kv/foo
|
||||
GET /v1/kv/foo
|
||||
```
|
||||
|
||||
Even though these share a path, the `PUT` operation creates a new key whereas
|
||||
the `GET` operation reads an existing key.
|
||||
|
||||
Here is the same example using `curl`:
|
||||
|
||||
```shell-session
|
||||
$ curl \
|
||||
--request PUT \
|
||||
--data 'hello consul' \
|
||||
http://127.0.0.1:8500/v1/kv/foo
|
||||
```
|
||||
|
||||
## URL-Encoded Resource Names
|
||||
|
||||
Some Consul HTTP API endpoints accept resource names in URL path or query parameters.
|
||||
To pass a resource name containing URL-invalid characters, such as `/` or ` `,
|
||||
URL-encode the resource name into the URL.
|
||||
|
||||
However, we generally recommend using resource names that don't require URL-encoding.
|
||||
Depending on the validation that Consul applies to a resource name,
|
||||
Consul may still reject a request if it considers the resource name invalid for that endpoint.
|
||||
And even if Consul considers the resource name valid, it may degrade other functionality,
|
||||
such as failed [DNS lookups](/docs/discovery/dns)
|
||||
for nodes or services with names containing invalid DNS characters.
|
||||
|
||||
This HTTP API capability also allows the
|
||||
[CLI to accept arguments with URL-invalid characters](/commands#arguments-with-url-invalid-characters).
|
||||
|
||||
### Invalid Characters
|
||||
|
||||
The linefeed character (`%0a`) will cause a request to be rejected even if it is URL-encoded.
|
||||
|
||||
## Translated Addresses
|
||||
|
||||
Consul 0.7 added the ability to translate addresses in HTTP response based on
|
||||
the configuration setting for
|
||||
[`translate_wan_addrs`](/docs/agent/config/config-files#translate_wan_addrs). In order
|
||||
to allow clients to know if address translation is in effect, the
|
||||
`X-Consul-Translate-Addresses` header will be added if translation is enabled,
|
||||
and will have a value of `true`. If translation is not enabled then this header
|
||||
will not be present.
|
||||
|
||||
## Default ACL Policy
|
||||
|
||||
All API responses for Consul versions after 1.9 will include an HTTP response
|
||||
header `X-Consul-Default-ACL-Policy` set to either "allow" or "deny" which
|
||||
mirrors the current value of the agent's
|
||||
[`acl.default_policy`](/docs/agent/config/config-files#acl_default_policy) option.
|
||||
|
||||
This is also the default [intention](/docs/connect/intentions) enforcement
|
||||
action if no intention matches.
|
||||
|
||||
This is returned even if ACLs are disabled.
|
||||
|
||||
## Results Filtered by ACLs
|
||||
|
||||
As of Consul 1.11, most list endpoints support an `X-Consul-Results-Filtered-By-ACLs`
|
||||
HTTP response header. This indicates that the response contains a partial subset
|
||||
of results, because some have been filtered out by ACL policies.
|
||||
|
||||
In order to limit information leakage, this header is only present for requests
|
||||
authenticated by a valid ACL token.
|
||||
|
||||
The following example uses `curl` to view the
|
||||
`X-Consul-Results-Filtered-By-ACLs` response header.
|
||||
|
||||
```shell-session
|
||||
$ curl \
|
||||
--header "X-Consul-Token: <non-anonymous consul token>" \
|
||||
--include \
|
||||
http://127.0.0.1:8500/v1/catalog/services
|
||||
|
||||
HTTP/1.1 200 OK
|
||||
Content-Type: application/json
|
||||
...
|
||||
X-Consul-Default-Acl-Policy: deny
|
||||
X-Consul-Results-Filtered-By-Acls: true
|
||||
|
||||
{
|
||||
"redis": [],
|
||||
"postgresql": ["primary", "secondary"]
|
||||
}
|
||||
```
|
||||
|
||||
## UUID Format
|
||||
|
||||
UUID-format identifiers generated by the Consul API use the
|
||||
[hashicorp/go-uuid](https://github.com/hashicorp/go-uuid) library.
|
||||
|
||||
These UUID-format strings are generated using high quality, purely random bytes.
|
||||
It is not intended to be RFC compliant, merely to use a well-understood string
|
||||
representation of a 128-bit value.
|
||||
|
|
@ -27,7 +27,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | -------------------------- |
|
||||
|
|
@ -179,7 +179,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | -------------------------- |
|
||||
|
|
@ -266,7 +266,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -301,7 +301,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -397,7 +397,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | -------------- |
|
||||
|
|
@ -502,7 +502,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | -------------------- | ------------------------ |
|
||||
|
|
@ -727,7 +727,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------------------ |
|
||||
|
|
@ -856,7 +856,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------------------ |
|
||||
|
|
@ -990,7 +990,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | -------------- |
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------------------------------------------- |
|
||||
|
|
@ -94,7 +94,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | -------------------------- |
|
||||
|
|
@ -165,7 +165,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | -------------------------- |
|
||||
|
|
@ -239,7 +239,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------------------------------------------- |
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -116,7 +116,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ----------------------------- |
|
||||
|
|
@ -161,7 +161,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ---------------- |
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------------------------ |
|
||||
|
|
@ -145,7 +145,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------------------------ |
|
||||
|
|
@ -242,7 +242,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------------------------ |
|
||||
|
|
@ -296,7 +296,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ----------------------------- |
|
||||
|
|
@ -368,7 +368,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ----------------------------- |
|
||||
|
|
@ -431,7 +431,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ----------------------------- |
|
||||
|
|
@ -518,7 +518,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------------------------ |
|
||||
|
|
@ -573,7 +573,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------------------------ |
|
||||
|
|
@ -629,7 +629,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ----------------------------- |
|
||||
|
|
@ -689,7 +689,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | -------------------- | ----------------------------- |
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -88,7 +88,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -147,7 +147,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -209,7 +209,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
|
|||
|
|
@ -4,10 +4,10 @@ page_title: Discovery Chain - HTTP API
|
|||
description: The /discovery-chain endpoints are for interacting with the discovery chain.
|
||||
---
|
||||
|
||||
-> **1.6.0+:** The discovery chain API is available in Consul versions 1.6.0 and newer.
|
||||
|
||||
# Discovery Chain HTTP Endpoint
|
||||
|
||||
-> **1.6.0+:** The discovery chain API is available in Consul versions 1.6.0 and newer.
|
||||
|
||||
~> This is a low-level API primarily targeted at developers building external
|
||||
[Connect proxy integrations](/docs/connect/proxies/integrate). Future
|
||||
high-level proxy integration APIs may obviate the need for this API over time.
|
||||
|
|
@ -41,7 +41,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | -------------------- | -------------- |
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------- |
|
||||
|
|
@ -101,7 +101,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------------------ |
|
||||
|
|
@ -125,7 +125,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------------------ |
|
||||
|
|
@ -215,7 +215,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| -------------------- | ----------------- | -------------------- | ------------------------ |
|
||||
|
|
@ -453,7 +453,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------------------ |
|
||||
|
|
|
|||
|
|
@ -1,161 +1,59 @@
|
|||
---
|
||||
layout: api
|
||||
page_title: HTTP API
|
||||
page_title: Consul HTTP API Overview
|
||||
description: |-
|
||||
Consul exposes a RESTful HTTP API to control almost every aspect of the
|
||||
Consul agent.
|
||||
Learn about the Consul REST API, which is the primary interface to all functionality available in Consul.
|
||||
---
|
||||
|
||||
# HTTP API Structure
|
||||
# Consul API Overview
|
||||
|
||||
The main interface to Consul is a RESTful HTTP API. The API can perform basic
|
||||
CRUD operations on nodes, services, checks, configuration, and more.
|
||||
The Consul HTTP API is a RESTful interface that allows you leverage Consul functionality in your network. This topic provides guidance about the essential API endpoints for different workstreams. Refer to the [HTTP API structure](/api-docs/api-structure) docs to learn how to interact with and authenticate against the Consul HTTP API.
|
||||
|
||||
## Authentication
|
||||
## Connect your services
|
||||
|
||||
When authentication is enabled, a Consul token should be provided to API
|
||||
requests using the `X-Consul-Token` header or with the
|
||||
Bearer scheme in the authorization header.
|
||||
This reduces the probability of the
|
||||
token accidentally getting logged or exposed. When using authentication,
|
||||
clients should communicate via TLS.
|
||||
Use the following API endpoints to configure and connect your services.
|
||||
|
||||
If no token is provided for an HTTP request then Consul will use the default ACL token
|
||||
if it has been configured. If no default ACL token was configured then the anonymous
|
||||
token will be used.
|
||||
- [`/catalog`](/api-docs/catalog): Register and deregister nodes, services, and health checks.
|
||||
- [`/health`](/api-docs/health): Query node health when health checks are enabled.
|
||||
- [`/query`](/api-docs/query): Create and manage prepared queries in Consul. Prepared queries allow you to register a complex service query and send it later.
|
||||
- [`/coordinate`](/api-docs/coordinate): Query the network coordinates for nodes in the local datacenter and Consul servers in the local datacenter and remote datacenters.
|
||||
|
||||
Below is an example using `curl` with `X-Consul-Token`.
|
||||
The following endpoints are specific to service mesh:
|
||||
|
||||
```shell-session
|
||||
$ curl \
|
||||
--header "X-Consul-Token: <consul token>" \
|
||||
http://127.0.0.1:8500/v1/agent/members
|
||||
```
|
||||
- [`/config`](/api-docs/config): Create, update, delete, and query central configuration entries registered with Consul. Configuration entries define the default behavior of resources in the service mesh.
|
||||
- [`/agent/connect`](/api-docs/agent/connect): Interact with local agents in the service mesh.
|
||||
- [`/connect`](/api-docs/connect): Manage service mesh-related operations, including service intentions ([`/connect/intentions`](/api-docs/connect/intentions)) and the service mesh Certificate Authority (CA) ([`/connect/ca`](/api-docs/connect/ca)).
|
||||
|
||||
Below is an example using `curl` with a [RFC6750](https://tools.ietf.org/html/rfc6750) Bearer token.
|
||||
|
||||
```shell-session
|
||||
$ curl \
|
||||
--header "Authorization: Bearer <consul token>" \
|
||||
http://127.0.0.1:8500/v1/agent/members
|
||||
```
|
||||
## Enable zero-trust network security
|
||||
|
||||
Previously this was provided via a `?token=` query parameter. This functionality
|
||||
exists on many endpoints for backwards compatibility, but its use is **highly
|
||||
discouraged**, since it can show up in access logs as part of the URL.
|
||||
The following API endpoints give you control over access to services in your network and access to the Consul API.
|
||||
|
||||
To learn more about the ACL system read the [documentation](/docs/security/acl).
|
||||
- [`/acl`](/api-docs/acl): Create and manage tokens that authenticate requests and authorize access to resources in the network. We recommend enabling access control lists (ACL) to secure access to the Consul API, UI, and CLI.
|
||||
- [`/connect/intentions`](/api-docs/connect/intentions): Create and manage service intentions.
|
||||
|
||||
## Version Prefix
|
||||
## Observe your network
|
||||
|
||||
All API routes are prefixed with `/v1/`. This documentation is only for the v1 API.
|
||||
Use the following API endpoints enable network observability.
|
||||
|
||||
## Formatted JSON Output
|
||||
- [`/status`](/api-docs/status): Debug your Consul datacenter by returning low-level Raft information about Consul server peers.
|
||||
- [`/agent/metrics`](/api-docs/agent#view-metrics): Retrieve metrics for the most recent finished intervals. For more information about metrics, refere to [Telemetry](/docs/agent/telemetry).
|
||||
|
||||
By default, the output of all HTTP API requests is minimized JSON. If the client
|
||||
passes `pretty` on the query string, formatted JSON will be returned.
|
||||
|
||||
## HTTP Methods
|
||||
## Manage consul
|
||||
|
||||
Consul's API aims to be RESTful, although there are some exceptions. The API
|
||||
responds to the standard HTTP verbs GET, PUT, and DELETE. Each API method will
|
||||
clearly document the verb(s) it responds to and the generated response. The same
|
||||
path with different verbs may trigger different behavior. For example:
|
||||
The following API endpoints help you manage Consul operations.
|
||||
|
||||
```text
|
||||
PUT /v1/kv/foo
|
||||
GET /v1/kv/foo
|
||||
```
|
||||
- [`/operator`](/api-docs/operator): Perform cluster-level tasks, such as interacting with the Raft subsystem or obtaining license information.
|
||||
- [`/partition`](/api-docs/partition): Create and manage administrative or admin partitions in Consul. Admin partitions are supersets of Consul namespaces that isolate groups of resources to lower operational overhead.
|
||||
- [`/namespace`](/api-docs/namespace): Create and manage namespaces in Consul. Namespaces isolate groups of resources to lower operational overhead.
|
||||
- [`/snapshot`](/api-docs/snapshot): Save and restore Consul server state in the event of a disaster.
|
||||
- [`/txn`](/api-docs/txn): Apply multiple operations, such as updating the catalog and retrieving multiple KV entries, in a single transaction.
|
||||
|
||||
Even though these share a path, the `PUT` operation creates a new key whereas
|
||||
the `GET` operation reads an existing key.
|
||||
## Configure your services dynamically
|
||||
|
||||
Here is the same example using `curl`:
|
||||
The following API endpoints enable you to dynamically configure your services.
|
||||
|
||||
```shell-session
|
||||
$ curl \
|
||||
--request PUT \
|
||||
--data 'hello consul' \
|
||||
http://127.0.0.1:8500/v1/kv/foo
|
||||
```
|
||||
|
||||
## URL-Encoded Resource Names
|
||||
|
||||
Some Consul HTTP API endpoints accept resource names in URL path or query parameters.
|
||||
To pass a resource name containing URL-invalid characters, such as `/` or ` `,
|
||||
URL-encode the resource name into the URL.
|
||||
|
||||
However, we generally recommend using resource names that don't require URL-encoding.
|
||||
Depending on the validation that Consul applies to a resource name,
|
||||
Consul may still reject a request if it considers the resource name invalid for that endpoint.
|
||||
And even if Consul considers the resource name valid, it may degrade other functionality,
|
||||
such as failed [DNS lookups](/docs/discovery/dns)
|
||||
for nodes or services with names containing invalid DNS characters.
|
||||
|
||||
This HTTP API capability also allows the
|
||||
[CLI to accept arguments with URL-invalid characters](/commands#arguments-with-url-invalid-characters).
|
||||
|
||||
### Invalid Characters
|
||||
|
||||
The linefeed character (`%0a`) will cause a request to be rejected even if it is URL-encoded.
|
||||
|
||||
## Translated Addresses
|
||||
|
||||
Consul 0.7 added the ability to translate addresses in HTTP response based on
|
||||
the configuration setting for
|
||||
[`translate_wan_addrs`](/docs/agent/config/config-files#translate_wan_addrs). In order
|
||||
to allow clients to know if address translation is in effect, the
|
||||
`X-Consul-Translate-Addresses` header will be added if translation is enabled,
|
||||
and will have a value of `true`. If translation is not enabled then this header
|
||||
will not be present.
|
||||
|
||||
## Default ACL Policy
|
||||
|
||||
All API responses for Consul versions after 1.9 will include an HTTP response
|
||||
header `X-Consul-Default-ACL-Policy` set to either "allow" or "deny" which
|
||||
mirrors the current value of the agent's
|
||||
[`acl.default_policy`](/docs/agent/config/config-files#acl_default_policy) option.
|
||||
|
||||
This is also the default [intention](/docs/connect/intentions) enforcement
|
||||
action if no intention matches.
|
||||
|
||||
This is returned even if ACLs are disabled.
|
||||
|
||||
## Results Filtered by ACLs
|
||||
|
||||
As of Consul 1.11, most list endpoints support an `X-Consul-Results-Filtered-By-ACLs`
|
||||
HTTP response header. This indicates that the response contains a partial subset
|
||||
of results, because some have been filtered out by ACL policies.
|
||||
|
||||
In order to limit information leakage, this header is only present for requests
|
||||
authenticated by a valid ACL token.
|
||||
|
||||
The following example uses `curl` to view the
|
||||
`X-Consul-Results-Filtered-By-ACLs` response header.
|
||||
|
||||
```shell-session
|
||||
$ curl \
|
||||
--header "X-Consul-Token: <non-anonymous consul token>" \
|
||||
--include \
|
||||
http://127.0.0.1:8500/v1/catalog/services
|
||||
|
||||
HTTP/1.1 200 OK
|
||||
Content-Type: application/json
|
||||
...
|
||||
X-Consul-Default-Acl-Policy: deny
|
||||
X-Consul-Results-Filtered-By-Acls: true
|
||||
|
||||
{
|
||||
"redis": [],
|
||||
"postgresql": ["primary", "secondary"]
|
||||
}
|
||||
```
|
||||
|
||||
## UUID Format
|
||||
|
||||
UUID-format identifiers generated by the Consul API use the
|
||||
[hashicorp/go-uuid](https://github.com/hashicorp/go-uuid) library.
|
||||
|
||||
These UUID-format strings are generated using high quality, purely random bytes.
|
||||
It is not intended to be RFC compliant, merely to use a well-understood string
|
||||
representation of a 128-bit value.
|
||||
- [`/event`](/api-docs/event): Start a custom event that you can use to build scripts and automations.
|
||||
- [`/kv`](/api-docs/kv): Add, remove, and update metadata stored in the Consul KV store.
|
||||
- [`/session`](/api-docs/session): Create and manage [sessions](/docs/dynamic-app-config/sessions) in Consul. You can use sessions to build distributed and granular locks to ensure nodes are properly writing to the Consul KV store.
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -171,7 +171,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -258,7 +258,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ---------------- |
|
||||
|
|
@ -154,7 +154,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------------------------------------------- |
|
||||
|
|
@ -224,7 +224,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ---------------- |
|
||||
|
|
@ -366,7 +366,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ---------------- |
|
||||
|
|
@ -438,7 +438,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------------------------------------------- |
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ---------------- |
|
||||
|
|
@ -108,7 +108,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | --------------- |
|
||||
|
|
@ -152,7 +152,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ---------------- |
|
||||
|
|
@ -199,7 +199,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | --------------- |
|
||||
|
|
@ -245,7 +245,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ---------------- |
|
||||
|
|
@ -283,7 +283,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ---------------- |
|
||||
|
|
@ -358,7 +358,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | --------------- |
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | --------------- |
|
||||
|
|
@ -82,7 +82,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ---------------- |
|
||||
|
|
@ -162,7 +162,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | --------------- |
|
||||
|
|
@ -266,7 +266,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | --------------- |
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | -------------- |
|
||||
|
|
@ -116,7 +116,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | --------------- |
|
||||
|
|
@ -165,7 +165,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | --------------- |
|
||||
|
|
@ -214,7 +214,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | --------------- |
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -91,7 +91,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ---------------- |
|
||||
|
|
@ -162,7 +162,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ---------------- |
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | --------------------- | ------------- | --------------- |
|
||||
|
|
@ -123,7 +123,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ---------------- |
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | --------------- |
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ---------------- |
|
||||
|
|
@ -93,7 +93,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ---------------- |
|
||||
|
|
@ -156,7 +156,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | -------------- |
|
||||
|
|
@ -212,7 +212,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ---------------- |
|
||||
|
|
@ -264,7 +264,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | -------------- |
|
||||
|
|
|
|||
|
|
@ -144,7 +144,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------- |
|
||||
|
|
@ -321,7 +321,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -383,7 +383,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------- |
|
||||
|
|
@ -423,7 +423,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -463,7 +463,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------- |
|
||||
|
|
@ -503,7 +503,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | --------------------- |
|
||||
|
|
@ -632,7 +632,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | --------------- |
|
||||
|
|
@ -131,7 +131,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | --------------- |
|
||||
|
|
@ -177,7 +177,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | -------------- |
|
||||
|
|
@ -240,7 +240,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | -------------- |
|
||||
|
|
@ -303,7 +303,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | -------------- |
|
||||
|
|
@ -361,7 +361,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | --------------- |
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -87,7 +87,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
@ -63,7 +63,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------ |
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ The table below shows this endpoint's support for
|
|||
[blocking queries](/api-docs/features/blocking),
|
||||
[consistency modes](/api-docs/features/consistency),
|
||||
[agent caching](/api-docs/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
[required ACLs](/api-docs#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ---------------------------------------------------------------------------------------------- |
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Corresponding HTTP API Endpoint: [\[PUT\] /v1/acl/auth-method](/api-docs/acl/aut
|
|||
|
||||
The `acl auth-method create` command creates new auth methods.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Corresponding HTTP API Endpoint: [\[DELETE\] /v1/acl/auth-method/:name](/api-doc
|
|||
|
||||
The `acl auth-method delete` command deletes an auth method.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Corresponding HTTP API Endpoint: [\[GET\] /v1/acl/auth-methods](/api-docs/acl/au
|
|||
|
||||
The `acl auth-method list` command lists all auth methods. By default it will not show metadata.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Corresponding HTTP API Endpoint: [\[GET\] /v1/acl/auth-method/:name](/api-docs/a
|
|||
|
||||
The `acl auth-method read` command reads and displays an auth method's details.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ default operations is to merge the current auth method with those values
|
|||
provided to the command invocation. Therefore to update just one field, only
|
||||
the `-name` options and the option to modify must be provided.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Corresponding HTTP API Endpoint: [\[PUT\] /v1/acl/binding-rule](/api-docs/acl/bi
|
|||
|
||||
The `acl binding-rule create` command creates new binding rules.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Corresponding HTTP API Endpoint: [\[DELETE\] /v1/acl/binding-rule/:id](/api-docs
|
|||
|
||||
The `acl binding-rule delete` command deletes a binding rule.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Corresponding HTTP API Endpoint: [\[GET\] /v1/acl/binding-rules](/api-docs/acl/b
|
|||
|
||||
The `acl binding-rule list` command lists all binding rules. By default it will not show metadata.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Corresponding HTTP API Endpoint: [\[GET\] /v1/acl/binding-rule/:id](/api-docs/ac
|
|||
|
||||
The `acl binding-rule read` command reads and displays a binding rules details.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ default operations is to merge the current binding rule with those values
|
|||
provided to the command invocation. Therefore to update just one field, only
|
||||
the `-id` option and the option to modify must be provided.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -12,9 +12,9 @@ Corresponding HTTP API Endpoint: [\[PUT\] /v1/acl/bootstrap](/api-docs/acl#boots
|
|||
The `acl bootstrap` command will request Consul to generate a new token with unlimited privileges to use
|
||||
for management purposes and output its details. This can only be done once and afterwards bootstrapping
|
||||
will be disabled. If all tokens are lost and you need to bootstrap again you can follow the bootstrap
|
||||
[reset procedure](https://learn.hashicorp.com/consul/security-networking/acl-troubleshooting?utm_source=consul.io&utm_medium=docs#reset-the-acl-system).
|
||||
[reset procedure](https://learn.hashicorp.com/consul/security-networking/acl-troubleshooting?utm_source=docs).
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ from stdin, a file or the raw value. To use stdin pass `-` as the value.
|
|||
To load the value from a file prefix the value with an `@`. Any other
|
||||
values will be used directly.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Corresponding HTTP API Endpoint: [\[DELETE\] /v1/acl/policy/:id](/api-docs/acl/p
|
|||
|
||||
The `acl policy delete` command deletes a policy. Policies may be deleted by their ID or by name.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Corresponding HTTP API Endpoint: [\[GET\] /v1/acl/policies](/api-docs/acl/polici
|
|||
|
||||
The `acl policy list` command lists all policies. By default it will not show metadata.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Corresponding HTTP API Endpoints: [\[GET\] /v1/acl/policy/:id](/api-docs/acl/pol
|
|||
|
||||
The `acl policy read` command reads and displays a policies details.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ the `-id` or `-name` options and the option to modify must be provided. Note tha
|
|||
policies requires both the `-id` and `-name` as the new name cannot yet be used to lookup the
|
||||
policy.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Corresponding HTTP API Endpoint: [\[PUT\] /v1/acl/role](/api-docs/acl/roles#crea
|
|||
|
||||
The `acl role create` command creates new roles.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Corresponding HTTP API Endpoint: [\[DELETE\] /v1/acl/role/:id](/api-docs/acl/rol
|
|||
|
||||
The `acl role delete` command deletes a role. Roles may be deleted by their ID or by name.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Corresponding HTTP API Endpoint: [\[GET\] /v1/acl/roles](/api-docs/acl/roles#lis
|
|||
|
||||
The `acl role list` command lists all roles. By default it will not show metadata.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Corresponding HTTP API Endpoints: [\[GET\] /v1/acl/role/:id](/api-docs/acl/roles
|
|||
|
||||
The `acl role read` command reads and displays a roles details.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ update just one field, only the `-id` or `-name` options and the option to
|
|||
modify must be provided. Note that renaming roles requires both the `-id` and
|
||||
`-name` as the new name cannot yet be used to lookup the role.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ the agent's configuration. Tokens are not persisted unless
|
|||
is `true`, so tokens will need to be updated again if that option is `false` and
|
||||
the agent is restarted.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Corresponding HTTP API Endpoint: [\[PUT\] /v1/acl/token/:AccessorID/clone](/api-
|
|||
|
||||
The `acl token clone` command clones an existing token.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ This command creates new tokens. When creating a new token, policies may be link
|
|||
either the `-policy-id` or the `-policy-name` options. When specifying policies by IDs you
|
||||
may use a unique prefix of the UUID as a shortcut for specifying the entire UUID.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Corresponding HTTP API Endpoint: [\[DELETE\] /v1/acl/token/:AccessorID](/api-doc
|
|||
|
||||
The `acl token delete` command deletes a token.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Corresponding HTTP API Endpoint: [\[GET\] /v1/acl/tokens](/api-docs/acl/tokens#l
|
|||
|
||||
The `acl token list` command lists all tokens. By default it will not show metadata.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Corresponding HTTP API Endpoint: [\[GET\] /v1/acl/token/:AccessorID](/api-docs/a
|
|||
|
||||
The `acl token read` command reads and displays a token details.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ Corresponding HTTP API Endpoint: [\[PUT\] /v1/acl/token/:AccessorID](/api-docs/a
|
|||
The `acl token update` command will update a token. Some parts of the token like whether the
|
||||
token is local to the datacenter cannot be changed.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ Corresponding HTTP API Endpoint: [\[GET\] /v1/acl/rules/translate/:accessor_id](
|
|||
|
||||
This command translates the legacy ACL rule syntax into the new syntax.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Corresponding HTTP API Endpoint: [\[GET\] /v1/catalog/datacenters](/api-docs/cat
|
|||
|
||||
The `catalog datacenters` command prints all known datacenters.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ The `catalog nodes` command prints all known nodes and metadata about them.
|
|||
It can also query for nodes that match a particular metadata or provide a
|
||||
particular service.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ The `catalog services` command prints all known services. It can also query
|
|||
for services that match particular metadata or list the services that a
|
||||
particular node provides.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ The `config delete` command deletes the configuration entry specified by the
|
|||
kind and name. See the [configuration entries docs](/docs/agent/config-entries)
|
||||
for more details about configuration entries.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ The `config list` command lists all given config entries of the given kind.
|
|||
See the [configuration entries docs](/docs/agent/config-entries) for more
|
||||
details about configuration entries.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ kind and name and outputs its JSON representation. See the
|
|||
[configuration entries docs](/docs/agent/config-entries) for more
|
||||
details about configuration entries.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ The `config write` command creates or updates a centralized config entry.
|
|||
See the [configuration entries docs](/docs/agent/config-entries) for more
|
||||
details about configuration entries.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ Subcommands:
|
|||
|
||||
This command displays the current CA configuration.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
@ -77,7 +77,7 @@ Modifies the current CA configuration. If this results in a new root certificate
|
|||
being used, the [Root Rotation](/docs/connect/ca#root-certificate-rotation) process
|
||||
will be triggered.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ message. It is hard to give an exact number, as it depends on various
|
|||
parameters of the event, but the payload should be kept very small
|
||||
(< 100 bytes). Specifying too large of an event will return an error.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ through the Consul servers and the Raft consensus algorithm, so having a large
|
|||
number of nodes in the cluster flow a large amount of data through the KV store
|
||||
could make the cluster unavailable.
|
||||
|
||||
The table below shows the [required ACLs](/api#authentication) in order to
|
||||
The table below shows the [required ACLs](/api-docs#authentication) in order to
|
||||
execute this command.
|
||||
|
||||
| ACL Required | Scope |
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ from the datacenter's member list nor from the raft configuration. Additionally,
|
|||
if the agent returns after transitioning to the "left" state, but before it is reaped
|
||||
from the member list, then it will rejoin the cluster.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -94,7 +94,7 @@ Command Options
|
|||
|
||||
## Authentication
|
||||
|
||||
When the [ACL system is enabled](/docs/agent/options#acl_enabled) the Consul CLI will
|
||||
When the [ACL system is enabled](/docs/agent/config/config-files#acl) the Consul CLI will
|
||||
require an [ACL token](/docs/security/acl#tokens) to perform API requests.
|
||||
|
||||
The ACL token can be provided directly on the command line using the `-token` command line flag,
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ intention read permissions and don't evaluate the result.
|
|||
defined as _deny_ intentions during evaluation, as this endpoint is only suited
|
||||
for networking layer 4 (e.g. TCP) integration.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ Corresponding HTTP API Endpoint: [\[POST\] /v1/connect/intentions](/api-docs/con
|
|||
|
||||
The `intention create` command creates or updates an L4 intention.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Corresponding HTTP API Endpoints: [\[DELETE\] /v1/connect/intentions/exact](/api
|
|||
|
||||
The `intention delete` command deletes a matching intention.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ Consul 1.9.0. Intentions no longer need IDs when represented as
|
|||
[`service-intentions`](/docs/connect/config-entries/service-intentions) config
|
||||
entries.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Corresponding HTTP API Endpoint: [\[GET\] /v1/connect/intentions](/api-docs/conn
|
|||
|
||||
The `intention list` command shows all intentions including ID and precedence.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ order: the first intention that matches a request would be evaluated.
|
|||
The [check](/commands/intention/check) command can be used to
|
||||
check whether an L4 connection would be authorized between any two services.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ state across the cluster.
|
|||
An agent which is already part of a cluster may join an agent in a different
|
||||
cluster, causing the two clusters to be merged into a single cluster.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ All variations of the `keyring` command return 0 if all nodes reply and there
|
|||
are no errors. If any node fails to reply or reports failure, the exit code
|
||||
will be 1.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ Corresponding HTTP API Endpoint: [\[DELETE\] /v1/kv/:key](/api-docs/kv#delete-ke
|
|||
The `kv delete` command removes the value from Consul's KV store at the
|
||||
given path. If no key exists at the path, no action is taken.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ prefix from Consul's KV store, and write a JSON representation to
|
|||
stdout. This can be used with the command "consul kv import" to move entire
|
||||
trees between Consul clusters.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ can be used with [`kv import`](/commands/kv/import) to move entire trees between
|
|||
Consul clusters. Alternatively, the [transaction API](/api-docs/txn) provides
|
||||
support for performing up to 64 KV operations atomically.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ Command: `consul kv import`
|
|||
The `kv import` command is used to import KV pairs from the JSON representation
|
||||
generated by the `kv export` command.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ The `kv put` command writes the data to the given path in the KV store.
|
|||
[transaction API](/api-docs/txn) provides support for performing up to
|
||||
64 KV operations atomically.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ non-graceful leave can affect cluster availability.
|
|||
Running `consul leave` on a server explicitly will reduce the quorum size. Even if the cluster used `bootstrap_expect` to set a quorum size initially, issuing `consul leave` on a server will reconfigure the cluster to have fewer servers.
|
||||
This means you could end up with just one server that is still able to commit writes because quorum is only 1, but those writes might be lost if that server fails before more are added.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ Consul Enterprise license management.
|
|||
If ACLs are enabled then a token with operator privileges may be required in
|
||||
order to use this command. Requests are forwarded internally to the leader
|
||||
if required, so this can be run from any Consul node in a cluster. See the
|
||||
[ACL Guide](https://learn.hashicorp.com/consul/security-networking/production-acls) for more information.
|
||||
[ACL Guide](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production) for more information.
|
||||
|
||||
```text
|
||||
Usage: consul license <subcommand> [options] [args]
|
||||
|
|
@ -129,7 +129,7 @@ Corresponding HTTP API Endpoint: [\[PUT\] /v1/operator/license](/api-docs/operat
|
|||
|
||||
This command sets the Consul Enterprise license.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
@ -169,7 +169,7 @@ Corresponding HTTP API Endpoint: [\[GET\] /v1/operator/license](/api-docs/operat
|
|||
|
||||
This command gets the Consul Enterprise license.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
@ -214,7 +214,7 @@ Corresponding HTTP API Endpoint: [\[DELETE\] /v1/operator/license](/api-docs/ope
|
|||
Resets license for the datacenter to the one builtin in Consul binary, if it is still valid.
|
||||
If the builtin license is invalid, the current one stays active.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ communication is disrupted, the child process is terminated.
|
|||
|
||||
The number of lock holders is configurable with the `-n` flag. By default,
|
||||
a single holder is allowed, and a lock is used for mutual exclusion. This
|
||||
uses the [leader election algorithm](https://learn.hashicorp.com/consul/developer-configuration/elections).
|
||||
uses the [leader election algorithm](https://learn.hashicorp.com/tutorials/consul/application-leader-elections).
|
||||
|
||||
If the lock holder count is more than one, then a semaphore is used instead.
|
||||
A semaphore allows more than a single holder, but this is less efficient than
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ requested auth method for a newly minted Consul ACL token. The companion
|
|||
command `consul logout` should be used to destroy any tokens created this way
|
||||
to avoid a resource leak.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ Corresponding HTTP API Endpoint: [\[POST\] /v1/acl/logout](/api-docs/acl#logout-
|
|||
The `logout` command will destroy the provided token if it was created from
|
||||
`consul login`.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ Under the hood, maintenance mode is activated by registering a health check in
|
|||
critical status against a service, and deactivated by deregistering the
|
||||
health check.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ Nodes in the "failed" state are still listed because Consul attempts to
|
|||
reconnect with failed nodes for a certain amount of time in the case
|
||||
that the failure is actually just a network partition.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ Corresponding HTTP API Endpoint: [\[PUT\] /v1/namespace](/api-docs/namespaces#cr
|
|||
This `namespace create` command creates a namespaces using the CLI parameters provided.
|
||||
This was added in Consul Enterprise 1.7.2.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ Corresponding HTTP API Endpoint: [\[DELETE\] /v1/namespace/:name](/api-docs/name
|
|||
This `namespace delete` command deletes a namespace. This was added in Consul Enterprise 1.7.0. If
|
||||
ACLs are enabled then this command will require a token with `operator:write` privileges.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ ACLs are enabled then this command will require a token with `operator:read` pri
|
|||
within the target namespaces. The results will be filtered based on the ACL token and therefore it is possible to
|
||||
see a partial list.
|
||||
|
||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
||||
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue