diff --git a/website/content/api-docs/acl/auth-methods.mdx b/website/content/api-docs/acl/auth-methods.mdx
index 0c840d12f4..1cd27be616 100644
--- a/website/content/api-docs/acl/auth-methods.mdx
+++ b/website/content/api-docs/acl/auth-methods.mdx
@@ -34,7 +34,9 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` |
-### Payload Fields
+The corresponding CLI command is [`consul acl auth-method create`](/commands/acl/auth-method/create).
+
+### Parameters
- `Name` `(string: )` - Specifies a name for the ACL auth method. The
name can contain alphanumeric characters, dashes `-`, and underscores `_`.
@@ -160,6 +162,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` |
+The corresponding CLI command is [`consul acl auth-method read`](/commands/acl/auth-method/read).
+
### Parameters
- `name` `(string: )` - Specifies the name of the ACL auth method to
@@ -212,6 +216,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` |
+The corresponding CLI command is [`consul acl auth-method update`](/commands/acl/auth-method/update).
+
### Parameters
- `Name` `(string: )` - Specifies the name of the auth method to
@@ -343,6 +349,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` |
+The corresponding CLI command is [`consul acl auth-method delete`](/commands/acl/auth-method/delete).
+
### Parameters
- `name` `(string: )` - Specifies the name of the ACL auth method to
@@ -385,6 +393,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` |
+The corresponding CLI command is [`consul acl auth-method list`](/commands/acl/auth-method/list).
+
### Parameters
- `ns` `(string: "")` - Specifies the namespace to list
diff --git a/website/content/api-docs/acl/binding-rules.mdx b/website/content/api-docs/acl/binding-rules.mdx
index 74ad21f854..e979d34407 100644
--- a/website/content/api-docs/acl/binding-rules.mdx
+++ b/website/content/api-docs/acl/binding-rules.mdx
@@ -34,6 +34,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` |
+The corresponding CLI command is [`consul acl binding-rule create`](/commands/acl/binding-rule/create).
+
### Parameters
- `Description` `(string: "")` - Free form human readable description of the binding rule.
@@ -158,6 +160,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` |
+The corresponding CLI command is [`consul acl binding-rule read`](/commands/acl/binding-rule/read).
+
### Parameters
- `id` `(string: )` - Specifies the UUID of the ACL binding rule
@@ -208,6 +212,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` |
+The corresponding CLI command is [`consul acl binding-rule update`](/commands/acl/binding-rule/update).
+
### Parameters
- `ID` `(string: )` - Specifies the ID of the binding rule to update.
@@ -338,6 +344,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` |
+The corresponding CLI command is [`consul acl binding-rule delete`](/commands/acl/binding-rule/delete).
+
### Parameters
- `id` `(string: )` - Specifies the UUID of the ACL binding rule to
@@ -380,6 +388,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` |
+The corresponding CLI command is [`consul acl binding-rule list`](/commands/acl/binding-rule/list).
+
## Parameters
- `authmethod` `(string: "")` - Filters the binding rule list to those binding
diff --git a/website/content/api-docs/acl/index.mdx b/website/content/api-docs/acl/index.mdx
index a9963548f5..f6df49bc73 100644
--- a/website/content/api-docs/acl/index.mdx
+++ b/website/content/api-docs/acl/index.mdx
@@ -38,6 +38,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `none` |
+The corresponding CLI command is [`consul acl bootstrap`](/commands/acl/bootstrap).
+
### Sample Request
```shell-session
@@ -206,6 +208,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:read` |
+The corresponding CLI command is [`consul acl translate-rules`](/commands/acl/translate-rules).
+
### Sample Payload
```hcl
@@ -253,6 +257,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:read` |
+The corresponding CLI command is [`consul acl translate-rules`](/commands/acl/translate-rules).
+
### Sample Request
```shell-session
@@ -294,6 +300,8 @@ enabled. Login requires the ability to create local tokens which is restricted
to the primary datacenter and any secondary datacenters with ACL token
replication enabled.
+The corresponding CLI command is [`consul login`](/commands/login).
+
### Parameters
- `AuthMethod` `(string: )` - The name of the auth method to use for login.
@@ -380,6 +388,8 @@ The table below shows this endpoint's support for
-> **Note** - This endpoint requires no specific privileges as it is just
deleting a token for which you already must possess its secret.
+The corresponding CLI command is [`consul logout`](/commands/logout).
+
### Sample Request
```shell-session
diff --git a/website/content/api-docs/acl/policies.mdx b/website/content/api-docs/acl/policies.mdx
index cd9bb411de..a33bd2ea8e 100644
--- a/website/content/api-docs/acl/policies.mdx
+++ b/website/content/api-docs/acl/policies.mdx
@@ -33,6 +33,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` |
+The corresponding CLI command is [`consul acl policy create`](/commands/acl/policy/create).
+
### Parameters
- `Name` `(string: )` - Specifies a name for the ACL policy. The name
@@ -106,6 +108,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` |
+The corresponding CLI command is [`consul acl policy read`](/commands/acl/policy/read).
+
### Parameters
- `id` `(string: )` - Specifies the UUID of the ACL policy to
@@ -156,6 +160,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` |
+The corresponding CLI command is [`consul acl policy read -name=`](/commands/acl/policy/read#name).
+
### Parameters
- `name` `(string: )` - Specifies the name of the ACL policy to
@@ -206,6 +212,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` |
+The corresponding CLI command is [`consul acl policy update`](/commands/acl/policy/update).
+
### Parameters
- `ID` `(string: )` - Specifies the UUID of the policy to update. This is
@@ -285,6 +293,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` |
+The corresponding CLI command is [`consul acl policy delete`](/commands/acl/policy/delete).
+
### Parameters
- `id` `(string: )` - Specifies the UUID of the ACL policy to
@@ -327,6 +337,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` |
+The corresponding CLI command is [`consul acl policy list`](/commands/acl/policy/list).
+
### Parameters
- `ns` `(string: "")` - Specifies the namespace to list
diff --git a/website/content/api-docs/acl/roles.mdx b/website/content/api-docs/acl/roles.mdx
index c5509baa41..e6496bd64c 100644
--- a/website/content/api-docs/acl/roles.mdx
+++ b/website/content/api-docs/acl/roles.mdx
@@ -32,6 +32,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` |
+The corresponding CLI command is [`consul acl role create`](/commands/acl/role/create).
+
### Parameters
- `Name` `(string: )` - Specifies a name for the ACL role. The name
@@ -172,6 +174,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` |
+The corresponding CLI command is [`consul acl role read`](/commands/acl/role/read).
+
### Parameters
- `id` `(string: )` - Specifies the UUID of the ACL role to
@@ -242,6 +246,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` |
+The corresponding CLI command is [`consul acl role read -name=`](/commands/acl/role/read#name).
+
### Parameters
- `name` `(string: )` - Specifies the Name of the ACL role to
@@ -311,6 +317,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` |
+The corresponding CLI command is [`consul acl role update`](/commands/acl/role/update).
+
### Parameters
- `ID` `(string: )` - Specifies the ID of the role to update. This is
@@ -427,6 +435,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` |
+The corresponding CLI command is [`consul acl role delete`](/commands/acl/role/delete).
+
### Parameters
- `id` `(string: )` - Specifies the UUID of the ACL role to
@@ -469,6 +479,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` |
+The corresponding CLI command is [`consul acl role list`](/commands/acl/role/list).
+
## Parameters
- `policy` `(string: "")` - Filters the role list to those roles that are
diff --git a/website/content/api-docs/acl/tokens.mdx b/website/content/api-docs/acl/tokens.mdx
index 6c3a184beb..2f352af9ab 100644
--- a/website/content/api-docs/acl/tokens.mdx
+++ b/website/content/api-docs/acl/tokens.mdx
@@ -32,6 +32,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` |
+The corresponding CLI command is [`consul acl token create`](/commands/acl/token/create).
+
### Parameters
- `AccessorID` `(string: "")` - Specifies a UUID to use as the token's Accessor ID.
@@ -173,6 +175,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` |
+The corresponding CLI command is [`consul acl token read`](/commands/acl/token/read).
+
### Parameters
- `AccessorID` `(string: )` - Specifies the accessor ID of the ACL token to
@@ -243,6 +247,8 @@ The table below shows this endpoint's support for
-> **Note** - This endpoint requires no specific privileges as it is just
retrieving the data for a token that you must already possess its secret.
+The corresponding CLI command is [`consul acl token read -self`](/commands/acl/token/read#self).
+
### Sample Request
```shell-session
@@ -293,6 +299,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` |
+The corresponding CLI command is [`consul acl token update`](/commands/acl/token/update).
+
### Parameters
- `AccessorID` `(string: "")` - Specifies the accessor ID of the token being updated. This is
@@ -441,6 +449,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` |
+The corresponding CLI command is [`consul acl token clone`](/commands/acl/token/clone).
+
### Parameters
- `AccessorID` `(string: )` - The accessor ID of the token to clone. This is required
@@ -520,6 +530,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `acl:write` |
+The corresponding CLI command is [`consul acl token delete`](/commands/acl/token/delete).
+
### Parameters
- `AccessorID` `(string: )` - Specifies the accessor ID of the ACL token to
@@ -562,6 +574,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `acl:read` |
+The corresponding CLI command is [`consul acl token list`](/commands/acl/token/list).
+
## Parameters
- `policy` `(string: "")` - Filters the token list to those tokens that are
diff --git a/website/content/api-docs/admin-partitions.mdx b/website/content/api-docs/admin-partitions.mdx
index 13eec37e1a..061187d6b6 100644
--- a/website/content/api-docs/admin-partitions.mdx
+++ b/website/content/api-docs/admin-partitions.mdx
@@ -29,6 +29,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` |
+The corresponding CLI command is [`consul partition create`](/commands/partition#create).
+
### Parameters
- `Name` `(string: )` - The partition name. This must be a valid
@@ -85,6 +87,8 @@ The table below shows this endpoint's support for
1 A non-anonymous token can read its own partition.
+The corresponding CLI command is [`consul partition read`](/commands/partition#read).
+
### Parameters
- `name` `(string: )` - Specifies the partition to read. This
@@ -126,6 +130,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` |
+The corresponding CLI command is [`consul partition write`](/commands/partition#write).
+
### Parameters
- `Name` `(string: )` - The partition name. This must be a valid
@@ -188,6 +194,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` |
+The corresponding CLI command is [`consul partition delete`](/commands/partition#delete).
+
### Parameters
- `name` `(string: )` - Specifies the partition to delete. This
@@ -231,6 +239,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | --------------- |
| `NO` | `consistent` | `none` | `operator:read` |
+The corresponding CLI command is [`consul partition list`](/commands/partition#list).
+
### Sample Request
```shell-session
diff --git a/website/content/api-docs/agent/index.mdx b/website/content/api-docs/agent/index.mdx
index 5bcd4f2dae..899949f372 100644
--- a/website/content/api-docs/agent/index.mdx
+++ b/website/content/api-docs/agent/index.mdx
@@ -227,6 +227,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `node:read` |
+The corresponding CLI command is [`consul members`](/commands/members).
+
### Parameters
- `wan` `(bool: false)` - Specifies to list WAN members instead of the LAN
@@ -373,6 +375,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------- |
| `NO` | `none` | `none` | `agent:write` |
+The corresponding CLI command is [`consul reload`](/commands/reload).
+
### Sample Request
```shell-session
@@ -404,6 +408,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `node:write` |
+The corresponding CLI command is [`consul maint`](/commands/maint).
+
### Parameters
- `enable` `(bool: )` - Specifies whether to enable or disable
@@ -629,6 +635,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------- |
| `NO` | `none` | `none` | `agent:write` |
+The corresponding CLI command is [`consul join`](/commands/join).
+
### Parameters
- `address` `(string: )` - Specifies the address of the other agent to
@@ -669,6 +677,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------- |
| `NO` | `none` | `none` | `agent:write` |
+The corresponding CLI command is [`consul leave`](/commands/leave).
+
### Sample Request
```shell-session
@@ -706,6 +716,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` |
+The corresponding CLI command is [`consul force-leave`](/commands/force-leave).
+
### Parameters
- `node` `(string: )` - Specifies the name of the node to be forced into `left` state. This is specified as part of the URL.
@@ -780,6 +792,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------- |
| `NO` | `none` | `none` | `agent:write` |
+The corresponding CLI command is [`consul acl set-agent-token`](/commands/acl/set-agent-token).
+
### Parameters
- `Token` `(string: "")` - Specifies the ACL token to set.
diff --git a/website/content/api-docs/agent/service.mdx b/website/content/api-docs/agent/service.mdx
index b446b8a9c4..dfd0c90597 100644
--- a/website/content/api-docs/agent/service.mdx
+++ b/website/content/api-docs/agent/service.mdx
@@ -593,6 +593,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | --------------- |
| `NO` | `none` | `none` | `service:write` |
+The corresponding CLI command is [`consul services register`](/commands/services/register).
+
### Query string parameters
- `replace-existing-checks` - Missing health checks from the request will be deleted from the agent. Using this parameter allows to idempotently register a service and its checks without having to manually deregister checks.
@@ -766,6 +768,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | --------------- |
| `NO` | `none` | `none` | `service:write` |
+The corresponding CLI command is [`consul services deregister`](/commands/services/deregister).
+
### Parameters
- `service_id` `(string: )` - Specifies the ID of the service to
diff --git a/website/content/api-docs/catalog.mdx b/website/content/api-docs/catalog.mdx
index b3d8a3b2b8..c269ed0f8b 100644
--- a/website/content/api-docs/catalog.mdx
+++ b/website/content/api-docs/catalog.mdx
@@ -266,6 +266,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `none` |
+The corresponding CLI command is [`consul catalog datacenters`](/commands/catalog/datacenters).
+
### Sample Request
```shell-session
@@ -297,6 +299,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `node:read` |
+The corresponding CLI command is [`consul catalog nodes`](/commands/catalog/nodes).
+
### Parameters
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to
@@ -392,6 +396,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | -------------- |
| `YES` | `all` | `none` | `service:read` |
+The corresponding CLI command is [`consul catalog services`](/commands/catalog/services).
+
### Parameters
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to
diff --git a/website/content/api-docs/config.mdx b/website/content/api-docs/config.mdx
index 7587e14b3d..c8ea8172b4 100644
--- a/website/content/api-docs/config.mdx
+++ b/website/content/api-docs/config.mdx
@@ -48,6 +48,8 @@ The table below shows this endpoint's support for
| service-splitter | `service:write` |
| terminating-gateway | `operator:write` |
+The corresponding CLI command is [`consul config write`](/commands/config/write).
+
### Parameters
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to
@@ -115,6 +117,8 @@ The table below shows this endpoint's support for
| service-splitter | `service:read` |
| terminating-gateway | `service:read` |
+The corresponding CLI command is [`consul config read`](/commands/config/read).
+
### Parameters
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to
@@ -184,6 +188,8 @@ The table below shows this endpoint's support for
| service-splitter | `service:read` |
| terminating-gateway | `service:read` |
+The corresponding CLI command is [`consul config list`](/commands/config/list).
+
### Parameters
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to
@@ -258,6 +264,8 @@ The table below shows this endpoint's support for
| service-splitter | `service:write` |
| terminating-gateway | `operator:write ` |
+The corresponding CLI command is [`consul config delete`](/commands/config/delete).
+
### Parameters
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to
diff --git a/website/content/api-docs/connect/ca.mdx b/website/content/api-docs/connect/ca.mdx
index af413b022d..90a49d8c6d 100644
--- a/website/content/api-docs/connect/ca.mdx
+++ b/website/content/api-docs/connect/ca.mdx
@@ -125,6 +125,8 @@ The table below shows this endpoint's support for
1 ACL required was operator:read
prior to versions 1.8.6,
1.7.10, and 1.6.10.
+The corresponding CLI command is [`consul connect ca get-config`](/commands/connect/ca#get-config).
+
### Sample Request
```shell-session
@@ -165,6 +167,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` |
+The corresponding CLI command is [`consul connect ca set-config`](/commands/connect/ca#set-config).
+
### Parameters
- `Provider` `(string: )` - Specifies the CA provider type to use.
diff --git a/website/content/api-docs/connect/intentions.mdx b/website/content/api-docs/connect/intentions.mdx
index 46d794081b..a2f7eddcd0 100644
--- a/website/content/api-docs/connect/intentions.mdx
+++ b/website/content/api-docs/connect/intentions.mdx
@@ -54,6 +54,8 @@ The table below shows this endpoint's support for
for more details.
+The corresponding CLI command is [`consul intention create -replace`](/commands/intention/create#replace).
+
### URL Parameters
- `source` `(string: )` - Specifies the source service. This
@@ -163,6 +165,8 @@ The table below shows this endpoint's support for
for more details.
+The corresponding CLI command is [`consul intention create`](/commands/intention/create).
+
### URL Parameters
- `ns` `(string: "")` - Specifies the default
@@ -315,6 +319,8 @@ The table below shows this endpoint's support for
for more details.
+The corresponding CLI command is [`consul intention get`](/commands/intention/get).
+
### Parameters
- `source` `(string: )` - Specifies the source service. This
@@ -390,6 +396,8 @@ The table below shows this endpoint's support for
for more details.
+The corresponding CLI command is [`consul intention get`](/commands/intention/get).
+
### Parameters
- `uuid` `(string: )` - Specifies the UUID of the intention to read. This
@@ -450,6 +458,8 @@ The table below shows this endpoint's support for
for more details.
+The corresponding CLI command is [`consul intention list`](/commands/intention/list).
+
### Parameters
- `filter` `(string: "")` - Specifies the expression used to filter the
@@ -539,6 +549,8 @@ The table below shows this endpoint's support for
for more details.
+The corresponding CLI command is [`consul intention delete`](/commands/intention/delete).
+
### Parameters
- `source` `(string: )` - Specifies the source service. This
@@ -597,6 +609,8 @@ The table below shows this endpoint's support for
for more details.
+The corresponding CLI command is [`consul intention delete`](/commands/intention/delete).
+
### Parameters
- `uuid` `(string: )` - Specifies the UUID of the intention to delete. This
@@ -652,6 +666,8 @@ The table below shows this endpoint's support for
for more details.
+The corresponding CLI command is [`consul intention check`](/commands/intention/check).
+
### Parameters
- `source` `(string: )` - Specifies the source service. This
@@ -715,6 +731,8 @@ The table below shows this endpoint's support for
for more details.
+The corresponding CLI command is [`consul intention match`](/commands/intention/match).
+
### Parameters
- `by` `(string: )` - Specifies whether to match the "name" value
diff --git a/website/content/api-docs/coordinate.mdx b/website/content/api-docs/coordinate.mdx
index f3ff23bae7..f3328d5515 100644
--- a/website/content/api-docs/coordinate.mdx
+++ b/website/content/api-docs/coordinate.mdx
@@ -38,6 +38,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `none` |
+The corresponding CLI command is [`consul rtt -wan`](/commands/rtt#wan).
+
### Sample Request
```shell-session
@@ -90,6 +92,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `node:read` |
+The corresponding CLI command is [`consul rtt`](/commands/rtt).
+
### Parameters
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to
diff --git a/website/content/api-docs/event.mdx b/website/content/api-docs/event.mdx
index 8773a337cf..47ec7345d8 100644
--- a/website/content/api-docs/event.mdx
+++ b/website/content/api-docs/event.mdx
@@ -29,6 +29,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------- |
| `NO` | `none` | `none` | `event:write` |
+The corresponding CLI command is [`consul event`](/commands/event).
+
### Parameters
- `name` `(string: )` - Specifies the name of the event to fire. This
diff --git a/website/content/api-docs/kv.mdx b/website/content/api-docs/kv.mdx
index 05525e8963..65972f2d24 100644
--- a/website/content/api-docs/kv.mdx
+++ b/website/content/api-docs/kv.mdx
@@ -43,6 +43,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `YES` | `all` | `none` | `key:read` |
+The corresponding CLI command is [`consul kv get`](/commands/kv/get).
+
### Parameters
- `key` `(string: "")` - Specifies the path of the key to read.
@@ -173,6 +175,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `key:write` |
+The corresponding CLI command is [`consul kv put`](/commands/kv/put).
+
### Parameters
- `key` `(string: "")` - Specifies the path of the key.
@@ -259,6 +263,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `key:write` |
+The corresponding CLI command is [`consul kv delete`](/commands/kv/delete).
+
### Parameters
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to
diff --git a/website/content/api-docs/namespaces.mdx b/website/content/api-docs/namespaces.mdx
index dabb38dc6e..bf22ec6ca3 100644
--- a/website/content/api-docs/namespaces.mdx
+++ b/website/content/api-docs/namespaces.mdx
@@ -29,6 +29,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` |
+The corresponding CLI command is [`consul namespace create`](/commands/namespace/create).
+
### Parameters
- `Name` `(string: )` - The namespaces name. This must be a valid
@@ -161,6 +163,8 @@ The table below shows this endpoint's support for
1 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 corresponding CLI command is [`consul namespace read`](/commands/namespace/read).
+
### Parameters
- `name` `(string: )` - Specifies the namespace to read. This
@@ -227,6 +231,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` |
+The corresponding CLI command is [`consul namespace update`](/commands/namespace/update) or [`consul namespace write`](/commands/namespace/write).
+
### Parameters
- `Name` `(string: )` - The namespaces name. This must be a valid
@@ -364,6 +370,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` |
+The corresponding CLI command is [`consul namespace delete`](/commands/namespace/delete).
+
### Parameters
- `name` `(string: )` - Specifies the namespace to delete. This
@@ -436,6 +444,8 @@ The table below shows this endpoint's support for
1 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 corresponding CLI command is [`consul namespace list`](/commands/namespace/list).
+
### Sample Request
```shell-session
diff --git a/website/content/api-docs/operator/area.mdx b/website/content/api-docs/operator/area.mdx
index 6d941ca3d5..d4333503d5 100644
--- a/website/content/api-docs/operator/area.mdx
+++ b/website/content/api-docs/operator/area.mdx
@@ -45,6 +45,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` |
+The corresponding CLI command is [`consul operator area create`](/commands/operator/area#create).
+
### Parameters
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to
@@ -111,6 +113,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | --------------- |
| `YES` | `all` | `none` | `operator:read` |
+The corresponding CLI command is [`consul operator area list`](/commands/operator/area#list).
+
### Parameters
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to
@@ -154,6 +158,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` |
+The corresponding CLI command is [`consul operator area update`](/commands/operator/area#update).
+
### Parameters
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to
@@ -244,6 +250,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` |
+The corresponding CLI command is [`consul operator area delete`](/commands/operator/area#delete).
+
### Parameters
- `uuid` `(string: )` - Specifies the UUID of the area to delete. This
@@ -280,6 +288,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` |
+The corresponding CLI command is [`consul operator area join`](/commands/operator/area#join).
+
### Parameters
- `uuid` `(string: )` - Specifies the UUID of the area to join. This
@@ -353,6 +363,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | --------------- |
| `NO` | `none` | `none` | `operator:read` |
+The corresponding CLI command is [`consul operator area members`](/commands/operator/area#members).
+
### Parameters
- `uuid` `(string: )` - Specifies the UUID of the area to list. This
diff --git a/website/content/api-docs/operator/autopilot.mdx b/website/content/api-docs/operator/autopilot.mdx
index ed568e6484..89ffb67a36 100644
--- a/website/content/api-docs/operator/autopilot.mdx
+++ b/website/content/api-docs/operator/autopilot.mdx
@@ -33,6 +33,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | --------------- |
| `NO` | `none` | `none` | `operator:read` |
+The corresponding CLI command is [`consul operator autopilot get-config`](/commands/operator/autopilot#get-config).
+
### Parameters
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to
@@ -87,6 +89,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` |
+The corresponding CLI command is [`consul operator autopilot set-config`](/commands/operator/autopilot#set-config).
+
### Parameters
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to
@@ -269,6 +273,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | --------------- |
| `NO` | `none` | `none` | `operator:read` |
+The corresponding CLI command is [`consul operator autopilot state`](/commands/operator/autopilot#state).
+
### Parameters
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to
diff --git a/website/content/api-docs/operator/keyring.mdx b/website/content/api-docs/operator/keyring.mdx
index 4a1e868875..f493ad336b 100644
--- a/website/content/api-docs/operator/keyring.mdx
+++ b/website/content/api-docs/operator/keyring.mdx
@@ -35,6 +35,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | -------------- |
| `NO` | `none` | `none` | `keyring:read` |
+The corresponding CLI command is [`consul keyring -list`](/commands/keyring#list).
+
### Parameters
- `relay-factor` `(int: 0)` - Specifies the relay factor. Setting this to a
@@ -120,6 +122,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | --------------- |
| `NO` | `none` | `none` | `keyring:write` |
+The corresponding CLI command is [`consul keyring -intstall`](/commands/keyring#install).
+
### Parameters
- `relay-factor` `(int: 0)` - Specifies the relay factor. Setting this to a
@@ -166,6 +170,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | --------------- |
| `NO` | `none` | `none` | `keyring:write` |
+The corresponding CLI command is [`consul keyring -use`](/commands/keyring#use).
+
### Parameters
- `relay-factor` `(int: 0)` - Specifies the relay factor. Setting this to a
@@ -212,6 +218,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | --------------- |
| `NO` | `none` | `none` | `keyring:write` |
+The corresponding CLI command is [`consul keyring -remove`](/commands/keyring#remove).
+
### Parameters
- `relay-factor` `(int: 0)` - Specifies the relay factor. Setting this to a
diff --git a/website/content/api-docs/operator/license.mdx b/website/content/api-docs/operator/license.mdx
index 415491966e..ff0c0b657b 100644
--- a/website/content/api-docs/operator/license.mdx
+++ b/website/content/api-docs/operator/license.mdx
@@ -31,6 +31,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `all` | `none` | `none` |
+The corresponding CLI command is [`consul license get`](/commands/license#get).
+
### Parameters
- `dc` `(string: "")` - Specifies the datacenter whose license should be retrieved.
@@ -96,6 +98,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` |
+The corresponding CLI command is [`consul license put`](/commands/license#put).
+
### Parameters
- `dc` `(string: "")` - Specifies the datacenter whose license should be updated.
@@ -166,6 +170,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` |
+The corresponding CLI command is [`consul license reset`](/commands/license#reset).
+
### Parameters
- `dc` `(string: "")` - Specifies the datacenter whose license should be updated.
diff --git a/website/content/api-docs/operator/raft.mdx b/website/content/api-docs/operator/raft.mdx
index 995087d95d..6eee9365b5 100644
--- a/website/content/api-docs/operator/raft.mdx
+++ b/website/content/api-docs/operator/raft.mdx
@@ -130,6 +130,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ---------------- |
| `NO` | `none` | `none` | `operator:write` |
+The corresponding CLI command is [`consul operator raft remove-peer`](/commands/operator/raft#remove-peer).
+
### Parameters
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to
diff --git a/website/content/api-docs/snapshot.mdx b/website/content/api-docs/snapshot.mdx
index 07585524d9..af990ae108 100644
--- a/website/content/api-docs/snapshot.mdx
+++ b/website/content/api-docs/snapshot.mdx
@@ -39,6 +39,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `default,stale` | `none` | `management` |
+The corresponding CLI command is [`consul snapshot save`](/commands/snapshot/save).
+
### Parameters
- `dc` `(string: "")` - Specifies the datacenter to query. This will default
@@ -94,6 +96,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `management` |
+The corresponding CLI command is [`consul snapshot restore`](/commands/snapshot/restore).
+
### Parameters
- `dc` `(string: "")` - Specifies the datacenter to query. This will default
diff --git a/website/content/api-docs/status.mdx b/website/content/api-docs/status.mdx
index e2ad3ad9ea..c7cb3e5571 100644
--- a/website/content/api-docs/status.mdx
+++ b/website/content/api-docs/status.mdx
@@ -70,6 +70,8 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------ |
| `NO` | `none` | `none` | `none` |
+The corresponding CLI command is [`consul operator raft list-peers`](/commands/operator/raft#list-peers).
+
### Parameters
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to