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

Correcting CLI links and grammer changes

This commit is contained in:
Chip Vaughn 2022-01-11 10:37:48 -05:00
parent 7f61e9f677
commit 0f6e660077
23 changed files with 92 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
website/content/api-docs/acl/auth-methods.mdx
View File

@ -34,7 +34,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` | | `NO` | `none` | `none` | `acl:write` |
-> The corresponding CLI command is [`consul acl auth-method create`](https://www.consul.io/commands/acl/auth-method/create) -> The corresponding CLI command is [`consul acl auth-method create`](https://www.consul.io/commands/acl/auth-method/create).
### Parameters ### Parameters
@ -162,7 +162,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` | | `YES` | `all` | `none` | `acl:read` |
-> The corresponding CLI command is [`consul acl auth-method read`](https://www.consul.io/commands/acl/auth-method/read) -> The corresponding CLI command is [`consul acl auth-method read`](https://www.consul.io/commands/acl/auth-method/read).
### Parameters ### Parameters
@ -216,7 +216,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` | | `NO` | `none` | `none` | `acl:write` |
-> The corresponding CLI command is [`consul acl auth-method update`](https://www.consul.io/commands/acl/auth-method/update) -> The corresponding CLI command is [`consul acl auth-method update`](https://www.consul.io/commands/acl/auth-method/update).
### Parameters ### Parameters
@ -349,7 +349,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` | | `NO` | `none` | `none` | `acl:write` |
-> The corresponding CLI command is [`consul acl auth-method delete`](https://www.consul.io/commands/acl/auth-method/delete) -> The corresponding CLI command is [`consul acl auth-method delete`](/commands/acl/auth-method/delete).
### Parameters ### Parameters
@ -393,7 +393,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` | | `YES` | `all` | `none` | `acl:read` |
-> The corresponding CLI command is [`consul acl auth-method list`](https://www.consul.io/commands/acl/auth-method/list) -> The corresponding CLI command is [`consul acl auth-method list`](https://www.consul.io/commands/acl/auth-method/list).
### Parameters ### Parameters

10
website/content/api-docs/acl/binding-rules.mdx
View File

@ -34,7 +34,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` | | `NO` | `none` | `none` | `acl:write` |
-> The corresponding CLI command is [`consul acl binding-rule create`](https://www.consul.io/commands/acl/binding-rule/create) -> The corresponding CLI command is [`consul acl binding-rule create`](/commands/acl/binding-rule/create).
### Parameters ### Parameters
@ -160,7 +160,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` | | `YES` | `all` | `none` | `acl:read` |
-> The corresponding CLI command is [`consul acl binding-rule read`](https://www.consul.io/commands/acl/binding-rule/read) -> The corresponding CLI command is [`consul acl binding-rule read`](/commands/acl/binding-rule/read).
### Parameters ### Parameters
@ -212,7 +212,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` | | `NO` | `none` | `none` | `acl:write` |
-> The corresponding CLI command is [`consul acl binding-rule update`](https://www.consul.io/commands/acl/binding-rule/update) -> The corresponding CLI command is [`consul acl binding-rule update`](/commands/acl/binding-rule/update).
### Parameters ### Parameters
@ -344,7 +344,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` | | `NO` | `none` | `none` | `acl:write` |
-> The corresponding CLI command is [`consul acl binding-rule delete`](https://www.consul.io/commands/acl/binding-rule/delete) -> The corresponding CLI command is [`consul acl binding-rule delete`](/commands/acl/binding-rule/delete).
### Parameters ### Parameters
@ -388,7 +388,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` | | `YES` | `all` | `none` | `acl:read` |
-> The corresponding CLI command is [`consul acl binding-rule list`](https://www.consul.io/commands/acl/binding-rule/list) -> The corresponding CLI command is [`consul acl binding-rule list`](/commands/acl/binding-rule/list).
## Parameters ## Parameters

10
website/content/api-docs/acl/index.mdx
View File

@ -38,7 +38,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `none` | | `NO` | `none` | `none` | `none` |
-> The corresponding CLI command is [`consul acl bootstrap`](https://www.consul.io/commands/acl/bootstrap) -> The corresponding CLI command is [`consul acl bootstrap`](/commands/acl/bootstrap).
### Sample Request ### Sample Request
@ -204,7 +204,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:read` | | `NO` | `none` | `none` | `acl:read` |
-> The corresponding CLI command is [`consul acl translate-rules`](https://www.consul.io/commands/acl/translate-rules) -> The corresponding CLI command is [`consul acl translate-rules`](/commands/acl/translate-rules).
### Sample Payload ### Sample Payload
@ -253,7 +253,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:read` | | `NO` | `none` | `none` | `acl:read` |
-> The corresponding CLI command is [`consul acl translate-rules`](https://www.consul.io/commands/acl/translate-rules) -> The corresponding CLI command is [`consul acl translate-rules`](/commands/acl/translate-rules).
### Sample Request ### Sample Request
@ -296,7 +296,7 @@ enabled. Login requires the ability to create local tokens which is restricted
to the primary datacenter and any secondary datacenters with ACL token to the primary datacenter and any secondary datacenters with ACL token
replication enabled. replication enabled.
-> The corresponding CLI command is [`consul login`](https://www.consul.io/commands/login) -> The corresponding CLI command is [`consul login`](/commands/login).
### Parameters ### Parameters
@ -384,7 +384,7 @@ The table below shows this endpoint's support for
-> **Note** - This endpoint requires no specific privileges as it is just -> **Note** - This endpoint requires no specific privileges as it is just
deleting a token for which you already must possess its secret. deleting a token for which you already must possess its secret.
-> The corresponding CLI command is [`consul logout`](https://www.consul.io/commands/logout) -> The corresponding CLI command is [`consul logout`](/commands/logout).
### Sample Request ### Sample Request

12
website/content/api-docs/acl/policies.mdx
View File

@ -33,7 +33,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` | | `NO` | `none` | `none` | `acl:write` |
-> The corresponding CLI command is [`consul acl policy create`](https://www.consul.io/commands/acl/policy/create) -> The corresponding CLI command is [`consul acl policy create`](/commands/acl/policy/create).
### Parameters ### Parameters
@ -108,7 +108,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` | | `YES` | `all` | `none` | `acl:read` |
-> The corresponding CLI command is [`consul acl policy read`](https://www.consul.io/commands/acl/policy/read) -> The corresponding CLI command is [`consul acl policy read`](/commands/acl/policy/read).
### Parameters ### Parameters
@ -160,7 +160,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` | | `YES` | `all` | `none` | `acl:read` |
-> The corresponding CLI command is [`consul acl policy read -name=<string>`](https://www.consul.io/commands/acl/policy/read#name) -> The corresponding CLI command is [`consul acl policy read -name=<string>`](/commands/acl/policy/read#name).
### Parameters ### Parameters
@ -212,7 +212,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` | | `NO` | `none` | `none` | `acl:write` |
-> The corresponding CLI command is [`consul acl policy update`](https://www.consul.io/commands/acl/policy/update) -> The corresponding CLI command is [`consul acl policy update`](/commands/acl/policy/update).
### Parameters ### Parameters
@ -293,7 +293,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` | | `NO` | `none` | `none` | `acl:write` |
-> The corresponding CLI command is [`consul acl policy delete`](https://www.consul.io/commands/acl/policy/delete) -> The corresponding CLI command is [`consul acl policy delete`](/commands/acl/policy/delete).
### Parameters ### Parameters
@ -337,7 +337,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` | | `YES` | `all` | `none` | `acl:read` |
-> The corresponding CLI command is [`consul acl policy list`](https://www.consul.io/commands/acl/policy/list) -> The corresponding CLI command is [`consul acl policy list`](/commands/acl/policy/list).
### Parameters ### Parameters

12
website/content/api-docs/acl/roles.mdx
View File

@ -32,7 +32,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` | | `NO` | `none` | `none` | `acl:write` |
-> The corresponding CLI command is [`consul acl role create`](https://www.consul.io/commands/acl/role/create) -> The corresponding CLI command is [`consul acl role create`](/commands/acl/role/create).
### Parameters ### Parameters
@ -174,7 +174,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` | | `YES` | `all` | `none` | `acl:read` |
-> The corresponding CLI command is [`consul acl role read`](https://www.consul.io/commands/acl/role/read) -> The corresponding CLI command is [`consul acl role read`](/commands/acl/role/read).
### Parameters ### Parameters
@ -246,7 +246,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` | | `YES` | `all` | `none` | `acl:read` |
-> The corresponding CLI command is [`consul acl role read -name=<string>`](https://www.consul.io/commands/acl/role/read#name) -> The corresponding CLI command is [`consul acl role read -name=<string>`](/commands/acl/role/read#name).
### Parameters ### Parameters
@ -317,7 +317,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` | | `NO` | `none` | `none` | `acl:write` |
-> The corresponding CLI command is [`consul acl role update`](https://www.consul.io/commands/acl/role/update) -> The corresponding CLI command is [`consul acl role update`](/commands/acl/role/update).
### Parameters ### Parameters
@ -435,7 +435,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` | | `NO` | `none` | `none` | `acl:write` |
-> The corresponding CLI command is [`consul acl role delete`](https://www.consul.io/commands/acl/role/delete) -> The corresponding CLI command is [`consul acl role delete`](/commands/acl/role/delete).
### Parameters ### Parameters
@ -479,7 +479,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` | | `YES` | `all` | `none` | `acl:read` |
-> The corresponding CLI command is [`consul acl role list`](https://www.consul.io/commands/acl/role/list) -> The corresponding CLI command is [`consul acl role list`](/commands/acl/role/list).
## Parameters ## Parameters

14
website/content/api-docs/acl/tokens.mdx
View File

@ -32,7 +32,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` | | `NO` | `none` | `none` | `acl:write` |
-> The corresponding CLI command is [`consul acl token create`](https://www.consul.io/commands/acl/token/create) -> The corresponding CLI command is [`consul acl token create`](/commands/acl/token/create).
### Parameters ### Parameters
@ -175,7 +175,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` | | `YES` | `all` | `none` | `acl:read` |
-> The corresponding CLI command is [`consul acl token read`](https://www.consul.io/commands/acl/token/read) -> The corresponding CLI command is [`consul acl token read`](/commands/acl/token/read).
### Parameters ### Parameters
@ -247,7 +247,7 @@ The table below shows this endpoint's support for
-> **Note** - This endpoint requires no specific privileges as it is just -> **Note** - This endpoint requires no specific privileges as it is just
retrieving the data for a token that you must already possess its secret. retrieving the data for a token that you must already possess its secret.
-> The corresponding CLI command is [`consul acl token read -self`](https://www.consul.io/commands/acl/token/read#self) -> The corresponding CLI command is [`consul acl token read -self`](/commands/acl/token/read#self).
### Sample Request ### Sample Request
@ -299,7 +299,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` | | `NO` | `none` | `none` | `acl:write` |
-> The corresponding CLI command is [`consul acl token update`](https://www.consul.io/commands/acl/token/update) -> The corresponding CLI command is [`consul acl token update`](/commands/acl/token/update).
### Parameters ### Parameters
@ -449,7 +449,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` | | `NO` | `none` | `none` | `acl:write` |
-> The corresponding CLI command is [`consul acl token clone`](https://www.consul.io/commands/acl/token/clone) -> The corresponding CLI command is [`consul acl token clone`](/commands/acl/token/clone).
### Parameters ### Parameters
@ -530,7 +530,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` | | `NO` | `none` | `none` | `acl:write` |
-> The corresponding CLI command is [`consul acl token delete`](https://www.consul.io/commands/acl/token/delete) -> The corresponding CLI command is [`consul acl token delete`](/commands/acl/token/delete).
### Parameters ### Parameters
@ -574,7 +574,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` | | `YES` | `all` | `none` | `acl:read` |
-> The corresponding CLI command is [`consul acl token list`](https://www.consul.io/commands/acl/token/list) -> The corresponding CLI command is [`consul acl token list`](/commands/acl/token/list).
## Parameters ## Parameters

14
website/content/api-docs/agent/index.mdx
View File

@ -227,7 +227,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `node:read` | | `NO` | `none` | `none` | `node:read` |
-> The corresponding CLI command is [`consul members`](https://www.consul.io/commands/members) -> The corresponding CLI command is [`consul members`](/commands/members).
### Parameters ### Parameters
@ -375,7 +375,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------- | | ---------------- | ----------------- | ------------- | ------------- |
| `NO` | `none` | `none` | `agent:write` | | `NO` | `none` | `none` | `agent:write` |
-> The corresponding CLI command is [`consul reload`](https://www.consul.io/commands/reload) -> The corresponding CLI command is [`consul reload`](/commands/reload).
### Sample Request ### Sample Request
@ -408,7 +408,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `node:write` | | `NO` | `none` | `none` | `node:write` |
-> The corresponding CLI command is [`consul maint`](https://www.consul.io/commands/maint) -> The corresponding CLI command is [`consul maint`](/commands/maint).
### Parameters ### Parameters
@ -635,7 +635,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------- | | ---------------- | ----------------- | ------------- | ------------- |
| `NO` | `none` | `none` | `agent:write` | | `NO` | `none` | `none` | `agent:write` |
-> The corresponding CLI command is [`consul join`](https://www.consul.io/commands/join) -> The corresponding CLI command is [`consul join`](/commands/join).
### Parameters ### Parameters
@ -677,7 +677,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------- | | ---------------- | ----------------- | ------------- | ------------- |
| `NO` | `none` | `none` | `agent:write` | | `NO` | `none` | `none` | `agent:write` |
-> The corresponding CLI command is [`consul leave`](https://www.consul.io/commands/leave) -> The corresponding CLI command is [`consul leave`](/commands/leave).
### Sample Request ### Sample Request
@ -716,7 +716,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- | | ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` | | `NO` | `none` | `none` | `operator:write` |
-> The corresponding CLI command is [`consul force-leave`](https://www.consul.io/commands/force-leave) -> The corresponding CLI command is [`consul force-leave`](/commands/force-leave).
### Parameters ### Parameters
@ -792,7 +792,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------- | | ---------------- | ----------------- | ------------- | ------------- |
| `NO` | `none` | `none` | `agent:write` | | `NO` | `none` | `none` | `agent:write` |
-> The corresponding CLI command is [`consul acl set-agent-token`](https://www.consul.io/commands/acl/set-agent-token) -> The corresponding CLI command is [`consul acl set-agent-token`](/commands/acl/set-agent-token).
### Parameters ### Parameters

4
website/content/api-docs/agent/service.mdx
View File

@ -593,7 +593,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | --------------- | | ---------------- | ----------------- | ------------- | --------------- |
| `NO` | `none` | `none` | `service:write` | | `NO` | `none` | `none` | `service:write` |
-> The corresponding CLI command is [`consul services register`](https://www.consul.io/commands/services/register) -> The corresponding CLI command is [`consul services register`](/commands/services/register).
### Query string parameters ### Query string parameters
@ -768,7 +768,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | --------------- | | ---------------- | ----------------- | ------------- | --------------- |
| `NO` | `none` | `none` | `service:write` | | `NO` | `none` | `none` | `service:write` |
-> The corresponding CLI command is [`consul services deregister`](https://www.consul.io/commands/services/deregister) -> The corresponding CLI command is [`consul services deregister`](/commands/services/deregister).
### Parameters ### Parameters

6
website/content/api-docs/catalog.mdx
View File

@ -266,7 +266,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `none` | | `NO` | `none` | `none` | `none` |
-> The corresponding CLI command is [`consul catalog datacenters`](https://www.consul.io/commands/catalog/datacenters) -> The corresponding CLI command is [`consul catalog datacenters`](/commands/catalog/datacenters).
### Sample Request ### Sample Request
@ -299,7 +299,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `node:read` | | `YES` | `all` | `none` | `node:read` |
-> The corresponding CLI command is [`consul catalog nodes`](https://www.consul.io/commands/catalog/nodes) -> The corresponding CLI command is [`consul catalog nodes`](/commands/catalog/nodes).
### Parameters ### Parameters
@ -396,7 +396,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | -------------- | | ---------------- | ----------------- | ------------- | -------------- |
| `YES` | `all` | `none` | `service:read` | | `YES` | `all` | `none` | `service:read` |
-> The corresponding CLI command is [`consul catalog services`](https://www.consul.io/commands/catalog/services) -> The corresponding CLI command is [`consul catalog services`](/commands/catalog/services).
### Parameters ### Parameters

8
website/content/api-docs/config.mdx
View File

@ -48,7 +48,7 @@ The table below shows this endpoint's support for
| service-splitter | `service:write` | | service-splitter | `service:write` |
| terminating-gateway | `operator:write` | | terminating-gateway | `operator:write` |
-> The corresponding CLI command is [`consul config write`](https://www.consul.io/commands/config/write) -> The corresponding CLI command is [`consul config write`](/commands/config/write).
### Parameters ### Parameters
@ -117,7 +117,7 @@ The table below shows this endpoint's support for
| service-splitter | `service:read` | | service-splitter | `service:read` |
| terminating-gateway | `service:read` | | terminating-gateway | `service:read` |
-> The corresponding CLI command is [`consul config read`](https://www.consul.io/commands/config/read) -> The corresponding CLI command is [`consul config read`](/commands/config/read).
### Parameters ### Parameters
@ -188,7 +188,7 @@ The table below shows this endpoint's support for
| service-splitter | `service:read` | | service-splitter | `service:read` |
| terminating-gateway | `service:read` | | terminating-gateway | `service:read` |
-> The corresponding CLI command is [`consul config list`](https://www.consul.io/commands/config/list) -> The corresponding CLI command is [`consul config list`](/commands/config/list).
### Parameters ### Parameters
@ -264,7 +264,7 @@ The table below shows this endpoint's support for
| service-splitter | `service:write` | | service-splitter | `service:write` |
| terminating-gateway | `operator:write ` | | terminating-gateway | `operator:write ` |
-> The corresponding CLI command is [`consul config delete`](https://www.consul.io/commands/config/delete) -> The corresponding CLI command is [`consul config delete`](/commands/config/delete).
### Parameters ### Parameters

4
website/content/api-docs/connect/ca.mdx
View File

@ -125,7 +125,7 @@ The table below shows this endpoint's support for
<sup>1</sup> ACL required was <code>operator:read</code> prior to versions 1.8.6, <sup>1</sup> ACL required was <code>operator:read</code> prior to versions 1.8.6,
1.7.10, and 1.6.10. 1.7.10, and 1.6.10.
-> The corresponding CLI command is [`consul connect ca get-config`](https://www.consul.io/commands/connect/ca#get-config) -> The corresponding CLI command is [`consul connect ca get-config`](/commands/connect/ca#get-config).
### Sample Request ### Sample Request
@ -167,7 +167,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- | | ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` | | `NO` | `none` | `none` | `operator:write` |
-> The corresponding CLI command is [`consul connect ca set-config`](https://www.consul.io/commands/connect/ca#set-config) -> The corresponding CLI command is [`consul connect ca set-config`](/commands/connect/ca#set-config).
### Parameters ### Parameters

18
website/content/api-docs/connect/intentions.mdx
View File

@ -54,7 +54,7 @@ The table below shows this endpoint's support for
for more details. for more details.
</p> </p>
-> The corresponding CLI command is [`consul intention create -replace`](https://www.consul.io/commands/intention/create#replace) -> The corresponding CLI command is [`consul intention create -replace`](/commands/intention/create#replace).
### URL Parameters ### URL Parameters
@ -165,7 +165,7 @@ The table below shows this endpoint's support for
for more details. for more details.
</p> </p>
-> The corresponding CLI command is [`consul intention create`](https://www.consul.io/commands/intention/create) -> The corresponding CLI command is [`consul intention create`](/commands/intention/create).
### URL Parameters ### URL Parameters
@ -319,7 +319,7 @@ The table below shows this endpoint's support for
for more details. for more details.
</p> </p>
-> The corresponding CLI command is [`consul intention create`](https://www.consul.io/commands/intention/get) -> The corresponding CLI command is [`consul intention create`](/commands/intention/get).
### Parameters ### Parameters
@ -396,7 +396,7 @@ The table below shows this endpoint's support for
for more details. for more details.
</p> </p>
-> The corresponding CLI command is [`consul intention create`](https://www.consul.io/commands/intention/get) -> The corresponding CLI command is [`consul intention create`](/commands/intention/get).
### Parameters ### Parameters
@ -458,7 +458,7 @@ The table below shows this endpoint's support for
for more details. for more details.
</p> </p>
-> The corresponding CLI command is [`consul intention create`](https://www.consul.io/commands/intention/get) -> The corresponding CLI command is [`consul intention create`](/commands/intention/get).
### Parameters ### Parameters
@ -549,7 +549,7 @@ The table below shows this endpoint's support for
for more details. for more details.
</p> </p>
-> The corresponding CLI command is [`consul intention delete`](https://www.consul.io/commands/intention/delete) -> The corresponding CLI command is [`consul intention delete`](/commands/intention/delete).
### Parameters ### Parameters
@ -609,7 +609,7 @@ The table below shows this endpoint's support for
for more details. for more details.
</p> </p>
-> The corresponding CLI command is [`consul intention delete`](https://www.consul.io/commands/intention/delete) -> The corresponding CLI command is [`consul intention delete`](/commands/intention/delete).
### Parameters ### Parameters
@ -666,7 +666,7 @@ The table below shows this endpoint's support for
for more details. for more details.
</p> </p>
-> The corresponding CLI command is [`consul intention check`](https://www.consul.io/commands/intention/check) -> The corresponding CLI command is [`consul intention check`](/commands/intention/check).
### Parameters ### Parameters
@ -731,7 +731,7 @@ The table below shows this endpoint's support for
for more details. for more details.
</p> </p>
-> The corresponding CLI command is [`consul intention match`](https://www.consul.io/commands/intention/match) -> The corresponding CLI command is [`consul intention match`](/commands/intention/match).
### Parameters ### Parameters

4
website/content/api-docs/coordinate.mdx
View File

@ -38,7 +38,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `none` | | `NO` | `none` | `none` | `none` |
-> The corresponding CLI command is [`consul rtt -wan #`](https://www.consul.io/commands/rtt#wan) -> The corresponding CLI command is [`consul rtt -wan #`](/commands/rtt#wan).
### Sample Request ### Sample Request
@ -92,7 +92,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `node:read` | | `YES` | `all` | `none` | `node:read` |
-> The corresponding CLI command is [`consul rtt #`](https://www.consul.io/commands/rtt) -> The corresponding CLI command is [`consul rtt #`](/commands/rtt).
### Parameters ### Parameters

2
website/content/api-docs/event.mdx
View File

@ -29,7 +29,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------- | | ---------------- | ----------------- | ------------- | ------------- |
| `NO` | `none` | `none` | `event:write` | | `NO` | `none` | `none` | `event:write` |
-> The corresponding CLI command is [`consul event`](https://www.consul.io/commands/event) -> The corresponding CLI command is [`consul event`](/commands/event).
### Parameters ### Parameters

6
website/content/api-docs/kv.mdx
View File

@ -41,7 +41,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `key:read` | | `YES` | `all` | `none` | `key:read` |
-> The corresponding CLI command is [`consul kv get`](https://www.consul.io/commands/kv/get) -> The corresponding CLI command is [`consul kv get`](/commands/kv/get).
### Parameters ### Parameters
@ -173,7 +173,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `key:write` | | `NO` | `none` | `none` | `key:write` |
-> The corresponding CLI command is [`consul kv put`](https://www.consul.io/commands/kv/put) -> The corresponding CLI command is [`consul kv put`](/commands/kv/put).
### Parameters ### Parameters
@ -261,7 +261,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `key:write` | | `NO` | `none` | `none` | `key:write` |
-> The corresponding CLI command is [`consul kv delete`](https://www.consul.io/commands/kv/delete) -> The corresponding CLI command is [`consul kv delete`](/commands/kv/delete).
### Parameters ### Parameters

10
website/content/api-docs/namespaces.mdx
View File

@ -29,7 +29,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- | | ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` | | `NO` | `none` | `none` | `operator:write` |
-> The corresponding CLI command is [`consul namespace create`](https://www.consul.io/commands/namespace/create) -> The corresponding CLI command is [`consul namespace create`](/commands/namespace/create).
### Parameters ### Parameters
@ -163,7 +163,7 @@ The table below shows this endpoint's support for
<sup>1</sup> Access can be granted to list the Namespace if the token used when making <sup>1</sup> Access can be granted to list the Namespace if the token used when making
the request has been granted any access in the namespace (read, list or write). the request has been granted any access in the namespace (read, list or write).
-> The corresponding CLI command is [`consul namespace read`](https://www.consul.io/commands/namespace/read) -> The corresponding CLI command is [`consul namespace read`](/commands/namespace/read).
### Parameters ### Parameters
@ -231,7 +231,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- | | ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` | | `NO` | `none` | `none` | `operator:write` |
-> The corresponding CLI command is [`consul namespace update`](https://www.consul.io/commands/namespace/update) or [`consul namespace write`](https://www.consul.io/commands/namespace/write) -> The corresponding CLI command is [`consul namespace update`](/commands/namespace/update) or [`consul namespace write`](/commands/namespace/write).
### Parameters ### Parameters
@ -370,7 +370,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- | | ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` | | `NO` | `none` | `none` | `operator:write` |
-> The corresponding CLI command is [`consul namespace delete`](https://www.consul.io/commands/namespace/delete) -> The corresponding CLI command is [`consul namespace delete`](/commands/namespace/delete).
### Parameters ### Parameters
@ -444,7 +444,7 @@ The table below shows this endpoint's support for
<sup>1</sup> Access can be granted to list the Namespace if the token used when making <sup>1</sup> Access can be granted to list the Namespace if the token used when making
the request has been granted any access in the namespace (read, list or write). the request has been granted any access in the namespace (read, list or write).
-> The corresponding CLI command is [`consul namespace list`](https://www.consul.io/commands/namespace/list) -> The corresponding CLI command is [`consul namespace list`](/commands/namespace/list).
### Sample Request ### Sample Request

12
website/content/api-docs/operator/area.mdx
View File

@ -45,7 +45,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- | | ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` | | `NO` | `none` | `none` | `operator:write` |
-> The corresponding CLI command is [`consul operator area create`](https://www.consul.io/commands/operator/area#create) -> The corresponding CLI command is [`consul operator area create`](/commands/operator/area#create).
### Parameters ### Parameters
@ -113,7 +113,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | --------------- | | ---------------- | ----------------- | ------------- | --------------- |
| `YES` | `all` | `none` | `operator:read` | | `YES` | `all` | `none` | `operator:read` |
-> The corresponding CLI command is [`consul operator area list`](https://www.consul.io/commands/operator/area#list) -> The corresponding CLI command is [`consul operator area list`](/commands/operator/area#list).
### Parameters ### Parameters
@ -158,7 +158,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- | | ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` | | `NO` | `none` | `none` | `operator:write` |
-> The corresponding CLI command is [`consul operator area update`](https://www.consul.io/commands/operator/area#update) -> The corresponding CLI command is [`consul operator area update`](/commands/operator/area#update).
### Parameters ### Parameters
@ -250,7 +250,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- | | ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` | | `NO` | `none` | `none` | `operator:write` |
-> The corresponding CLI command is [`consul operator area delete`](https://www.consul.io/commands/operator/area#delete) -> The corresponding CLI command is [`consul operator area delete`](/commands/operator/area#delete).
### Parameters ### Parameters
@ -288,7 +288,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- | | ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` | | `NO` | `none` | `none` | `operator:write` |
-> The corresponding CLI command is [`consul operator area join`](https://www.consul.io/commands/operator/area#join) -> The corresponding CLI command is [`consul operator area join`](/commands/operator/area#join).
### Parameters ### Parameters
@ -363,7 +363,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | --------------- | | ---------------- | ----------------- | ------------- | --------------- |
| `NO` | `none` | `none` | `operator:read` | | `NO` | `none` | `none` | `operator:read` |
-> The corresponding CLI command is [`consul operator area members`](https://www.consul.io/commands/operator/area#members) -> The corresponding CLI command is [`consul operator area members`](/commands/operator/area#members).
### Parameters ### Parameters

6
website/content/api-docs/operator/autopilot.mdx
View File

@ -33,7 +33,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | --------------- | | ---------------- | ----------------- | ------------- | --------------- |
| `NO` | `none` | `none` | `operator:read` | | `NO` | `none` | `none` | `operator:read` |
-> The corresponding CLI command is [`consul operator autopilot get-config`](https://www.consul.io/commands/operator/autopilot#get-config) -> The corresponding CLI command is [`consul operator autopilot get-config`](/commands/operator/autopilot#get-config).
### Parameters ### Parameters
@ -89,7 +89,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- | | ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` | | `NO` | `none` | `none` | `operator:write` |
-> The corresponding CLI command is [`consul operator autopilot set-config`](https://www.consul.io/commands/operator/autopilot#set-config) -> The corresponding CLI command is [`consul operator autopilot set-config`](/commands/operator/autopilot#set-config).
### Parameters ### Parameters
@ -273,7 +273,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | --------------- | | ---------------- | ----------------- | ------------- | --------------- |
| `NO` | `none` | `none` | `operator:read` | | `NO` | `none` | `none` | `operator:read` |
-> The corresponding CLI command is [`consul operator autopilot state`](https://www.consul.io/commands/operator/autopilot#state) -> The corresponding CLI command is [`consul operator autopilot state`](/commands/operator/autopilot#state).
### Parameters ### Parameters

8
website/content/api-docs/operator/keyring.mdx
View File

@ -35,7 +35,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | -------------- | | ---------------- | ----------------- | ------------- | -------------- |
| `NO` | `none` | `none` | `keyring:read` | | `NO` | `none` | `none` | `keyring:read` |
-> The corresponding CLI command is [`consul keyring -list`](https://www.consul.io/commands/keyring#list) -> The corresponding CLI command is [`consul keyring -list`](/commands/keyring#list).
### Parameters ### Parameters
@ -122,7 +122,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | --------------- | | ---------------- | ----------------- | ------------- | --------------- |
| `NO` | `none` | `none` | `keyring:write` | | `NO` | `none` | `none` | `keyring:write` |
-> The corresponding CLI command is [`consul keyring -intstall`](https://www.consul.io/commands/keyring#install) -> The corresponding CLI command is [`consul keyring -intstall`](/commands/keyring#install).
### Parameters ### Parameters
@ -170,7 +170,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | --------------- | | ---------------- | ----------------- | ------------- | --------------- |
| `NO` | `none` | `none` | `keyring:write` | | `NO` | `none` | `none` | `keyring:write` |
-> The corresponding CLI command is [`consul keyring -use`](https://www.consul.io/commands/keyring#use) -> The corresponding CLI command is [`consul keyring -use`](/commands/keyring#use).
### Parameters ### Parameters
@ -218,7 +218,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | --------------- | | ---------------- | ----------------- | ------------- | --------------- |
| `NO` | `none` | `none` | `keyring:write` | | `NO` | `none` | `none` | `keyring:write` |
-> The corresponding CLI command is [`consul keyring -remove`](https://www.consul.io/commands/keyring#remove) -> The corresponding CLI command is [`consul keyring -remove`](/commands/keyring#remove).
### Parameters ### Parameters

6
website/content/api-docs/operator/license.mdx
View File

@ -31,7 +31,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `all` | `none` | `none` | | `NO` | `all` | `none` | `none` |
-> The corresponding CLI command is [`consul license get`](https://www.consul.io/commands/license#get) -> The corresponding CLI command is [`consul license get`](/commands/license#get).
### Parameters ### Parameters
@ -98,7 +98,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- | | ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` | | `NO` | `none` | `none` | `operator:write` |
-> The corresponding CLI command is [`consul license put`](https://www.consul.io/commands/license#put) -> The corresponding CLI command is [`consul license put`](/commands/license#put).
### Parameters ### Parameters
@ -170,7 +170,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- | | ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` | | `NO` | `none` | `none` | `operator:write` |
-> The corresponding CLI command is [`consul license reset`](https://www.consul.io/commands/license#reset) -> The corresponding CLI command is [`consul license reset`](/commands/license#reset).
### Parameters ### Parameters

2
website/content/api-docs/operator/raft.mdx
View File

@ -130,7 +130,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- | | ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` | | `NO` | `none` | `none` | `operator:write` |
-> The corresponding CLI command is [`consul operator raft remove-peer`](https://www.consul.io/commands/operator/raft#remove-peer) -> The corresponding CLI command is [`consul operator raft remove-peer`](/commands/operator/raft#remove-peer).
### Parameters ### Parameters

4
website/content/api-docs/snapshot.mdx
View File

@ -39,7 +39,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `default,stale` | `none` | `management` | | `NO` | `default,stale` | `none` | `management` |
-> The corresponding CLI command is [`consul snapshot save`](https://www.consul.io/commands/snapshot/save) -> The corresponding CLI command is [`consul snapshot save`](/commands/snapshot/save).
### Parameters ### Parameters
@ -96,7 +96,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `management` | | `NO` | `none` | `none` | `management` |
-> The corresponding CLI command is [`consul snapshot restore`](https://www.consul.io/commands/snapshot/restore) -> The corresponding CLI command is [`consul snapshot restore`](/commands/snapshot/restore).
### Parameters ### Parameters

2
website/content/api-docs/status.mdx
View File

@ -70,7 +70,7 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ | | ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `none` | | `NO` | `none` | `none` | `none` |
-> The corresponding CLI command is [`consul operator raft list-peers`](https://www.consul.io/commands/operator/raft#list-peers) -> The corresponding CLI command is [`consul operator raft list-peers`](/commands/operator/raft#list-peers).
### Parameters ### Parameters