From f3587417d0a80537b28263338c32bfd840714733 Mon Sep 17 00:00:00 2001 From: Chip Vaughn Date: Mon, 10 Jan 2022 14:21:32 -0500 Subject: [PATCH 1/8] Updating HTTP API endpoints with CLI equivalent links --- website/content/api-docs/acl/auth-methods.mdx | 12 +++++++++++- website/content/api-docs/acl/binding-rules.mdx | 10 ++++++++++ website/content/api-docs/acl/index.mdx | 10 ++++++++++ website/content/api-docs/acl/policies.mdx | 12 ++++++++++++ website/content/api-docs/acl/roles.mdx | 12 ++++++++++++ website/content/api-docs/acl/tokens.mdx | 14 ++++++++++++++ website/content/api-docs/agent/index.mdx | 14 ++++++++++++++ website/content/api-docs/agent/service.mdx | 4 ++++ website/content/api-docs/catalog.mdx | 6 ++++++ website/content/api-docs/config.mdx | 8 ++++++++ website/content/api-docs/connect/ca.mdx | 4 ++++ .../content/api-docs/connect/intentions.mdx | 18 ++++++++++++++++++ website/content/api-docs/coordinate.mdx | 4 ++++ website/content/api-docs/event.mdx | 2 ++ website/content/api-docs/kv.mdx | 6 ++++++ website/content/api-docs/namespaces.mdx | 10 ++++++++++ website/content/api-docs/operator/area.mdx | 12 ++++++++++++ .../content/api-docs/operator/autopilot.mdx | 6 ++++++ website/content/api-docs/operator/keyring.mdx | 8 ++++++++ website/content/api-docs/operator/license.mdx | 6 ++++++ website/content/api-docs/operator/raft.mdx | 2 ++ website/content/api-docs/snapshot.mdx | 4 ++++ website/content/api-docs/status.mdx | 2 ++ 23 files changed, 185 insertions(+), 1 deletion(-) diff --git a/website/content/api-docs/acl/auth-methods.mdx b/website/content/api-docs/acl/auth-methods.mdx index 9f4ebbbd37..076d9d2c38 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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 b598a55691..3375b2b412 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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 5c69331ed3..162e9eb016 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`](https://www.consul.io/commands/acl/bootstrap) + ### Sample Request ```shell-session @@ -202,6 +204,8 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `acl:read` | +-> The corresponding CLI command is [`consul acl translate-rules`](https://www.consul.io/commands/acl/translate-rules) + ### Sample Payload ```hcl @@ -249,6 +253,8 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `acl:read` | +-> The corresponding CLI command is [`consul acl translate-rules`](https://www.consul.io/commands/acl/translate-rules) + ### Sample Request ```shell-session @@ -290,6 +296,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`](https://www.consul.io/commands/login) + ### Parameters - `AuthMethod` `(string: )` - The name of the auth method to use for login. @@ -376,6 +384,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`](https://www.consul.io/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 6fe426d534..38c3c2e0a2 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`](https://www.consul.io/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`](https://www.consul.io/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=`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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 5862fefcf8..84ef0a0f63 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`](https://www.consul.io/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`](https://www.consul.io/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=`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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 4bdc026ae9..7554e6ebd6 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/commands/acl/token/list) + ## Parameters - `policy` `(string: "")` - Filters the token list to those tokens that are diff --git a/website/content/api-docs/agent/index.mdx b/website/content/api-docs/agent/index.mdx index 5bcd4f2dae..9fe617015f 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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 b475b36e46..78d83ac7fb 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`](https://www.consul.io/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`](https://www.consul.io/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 187a03769b..3c3503f74d 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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..56e5a8633b 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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..181c0cccc3 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`](https://www.consul.io/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`](https://www.consul.io/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 39912a9b18..30d4f13638 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`](https://www.consul.io/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`](https://www.consul.io/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 create`](https://www.consul.io/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 create`](https://www.consul.io/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 create`](https://www.consul.io/commands/intention/get) + ### 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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..6f2958095c 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 #`](https://www.consul.io/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 #`](https://www.consul.io/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..3a58f52fc3 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`](https://www.consul.io/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 cc99ed373d..efdeee9074 100644 --- a/website/content/api-docs/kv.mdx +++ b/website/content/api-docs/kv.mdx @@ -41,6 +41,8 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `YES` | `all` | `none` | `key:read` | +-> The corresponding CLI command is [`consul kv get`](https://www.consul.io/commands/kv/get) + ### Parameters - `key` `(string: "")` - Specifies the path of the key to read. @@ -171,6 +173,8 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `key:write` | +-> The corresponding CLI command is [`consul kv put`](https://www.consul.io/commands/kv/put) + ### Parameters - `key` `(string: "")` - Specifies the path of the key. @@ -257,6 +261,8 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `key:write` | +-> The corresponding CLI command is [`consul kv delete`](https://www.consul.io/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 27da27e122..ad8b032cbf 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/commands/namespace/update) or [`consul namespace write`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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..6529dc2c33 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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..23ca9edc95 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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..a2def36ef7 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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..467b88350c 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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 b56211b2cb..04fbfa2ebd 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`](https://www.consul.io/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 d94248a1b3..9080389af1 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`](https://www.consul.io/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`](https://www.consul.io/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..30b0f45aeb 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`](https://www.consul.io/commands/operator/raft#list-peers) + ### Parameters - `dc` `(string: "")` - Specifies the datacenter to query. This will default to From 9f629ae7e564691e50ff0ff32fa86cdb0c170309 Mon Sep 17 00:00:00 2001 From: Chip Vaughn Date: Mon, 10 Jan 2022 14:21:32 -0500 Subject: [PATCH 2/8] Editing links and grammer changes --- website/content/api-docs/acl/auth-methods.mdx | 12 +++++++++++- website/content/api-docs/acl/binding-rules.mdx | 10 ++++++++++ website/content/api-docs/acl/index.mdx | 10 ++++++++++ website/content/api-docs/acl/policies.mdx | 12 ++++++++++++ website/content/api-docs/acl/roles.mdx | 12 ++++++++++++ website/content/api-docs/acl/tokens.mdx | 14 ++++++++++++++ website/content/api-docs/agent/index.mdx | 14 ++++++++++++++ website/content/api-docs/agent/service.mdx | 4 ++++ website/content/api-docs/catalog.mdx | 6 ++++++ website/content/api-docs/config.mdx | 8 ++++++++ website/content/api-docs/connect/ca.mdx | 4 ++++ .../content/api-docs/connect/intentions.mdx | 18 ++++++++++++++++++ website/content/api-docs/coordinate.mdx | 4 ++++ website/content/api-docs/event.mdx | 2 ++ website/content/api-docs/kv.mdx | 6 ++++++ website/content/api-docs/namespaces.mdx | 10 ++++++++++ website/content/api-docs/operator/area.mdx | 12 ++++++++++++ .../content/api-docs/operator/autopilot.mdx | 6 ++++++ website/content/api-docs/operator/keyring.mdx | 8 ++++++++ website/content/api-docs/operator/license.mdx | 6 ++++++ website/content/api-docs/operator/raft.mdx | 2 ++ website/content/api-docs/snapshot.mdx | 4 ++++ website/content/api-docs/status.mdx | 2 ++ 23 files changed, 185 insertions(+), 1 deletion(-) diff --git a/website/content/api-docs/acl/auth-methods.mdx b/website/content/api-docs/acl/auth-methods.mdx index 9f4ebbbd37..076d9d2c38 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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 b598a55691..3375b2b412 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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 5c69331ed3..162e9eb016 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`](https://www.consul.io/commands/acl/bootstrap) + ### Sample Request ```shell-session @@ -202,6 +204,8 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `acl:read` | +-> The corresponding CLI command is [`consul acl translate-rules`](https://www.consul.io/commands/acl/translate-rules) + ### Sample Payload ```hcl @@ -249,6 +253,8 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `acl:read` | +-> The corresponding CLI command is [`consul acl translate-rules`](https://www.consul.io/commands/acl/translate-rules) + ### Sample Request ```shell-session @@ -290,6 +296,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`](https://www.consul.io/commands/login) + ### Parameters - `AuthMethod` `(string: )` - The name of the auth method to use for login. @@ -376,6 +384,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`](https://www.consul.io/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 6fe426d534..38c3c2e0a2 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`](https://www.consul.io/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`](https://www.consul.io/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=`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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 5862fefcf8..84ef0a0f63 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`](https://www.consul.io/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`](https://www.consul.io/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=`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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 4bdc026ae9..7554e6ebd6 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/commands/acl/token/list) + ## Parameters - `policy` `(string: "")` - Filters the token list to those tokens that are diff --git a/website/content/api-docs/agent/index.mdx b/website/content/api-docs/agent/index.mdx index 5bcd4f2dae..9fe617015f 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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 b475b36e46..78d83ac7fb 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`](https://www.consul.io/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`](https://www.consul.io/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 187a03769b..3c3503f74d 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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..56e5a8633b 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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..181c0cccc3 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`](https://www.consul.io/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`](https://www.consul.io/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 39912a9b18..30d4f13638 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`](https://www.consul.io/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`](https://www.consul.io/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 create`](https://www.consul.io/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 create`](https://www.consul.io/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 create`](https://www.consul.io/commands/intention/get) + ### 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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..6f2958095c 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 #`](https://www.consul.io/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 #`](https://www.consul.io/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..3a58f52fc3 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`](https://www.consul.io/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 cc99ed373d..efdeee9074 100644 --- a/website/content/api-docs/kv.mdx +++ b/website/content/api-docs/kv.mdx @@ -41,6 +41,8 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `YES` | `all` | `none` | `key:read` | +-> The corresponding CLI command is [`consul kv get`](https://www.consul.io/commands/kv/get) + ### Parameters - `key` `(string: "")` - Specifies the path of the key to read. @@ -171,6 +173,8 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `key:write` | +-> The corresponding CLI command is [`consul kv put`](https://www.consul.io/commands/kv/put) + ### Parameters - `key` `(string: "")` - Specifies the path of the key. @@ -257,6 +261,8 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `key:write` | +-> The corresponding CLI command is [`consul kv delete`](https://www.consul.io/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 27da27e122..ad8b032cbf 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/commands/namespace/update) or [`consul namespace write`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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..6529dc2c33 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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..23ca9edc95 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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..a2def36ef7 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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..467b88350c 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`](https://www.consul.io/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`](https://www.consul.io/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`](https://www.consul.io/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 b56211b2cb..04fbfa2ebd 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`](https://www.consul.io/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 d94248a1b3..9080389af1 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`](https://www.consul.io/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`](https://www.consul.io/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..30b0f45aeb 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`](https://www.consul.io/commands/operator/raft#list-peers) + ### Parameters - `dc` `(string: "")` - Specifies the datacenter to query. This will default to From 4d6128d28d91847ce7f2856368906bd3a9a175ad Mon Sep 17 00:00:00 2001 From: Chip Vaughn Date: Tue, 11 Jan 2022 10:37:48 -0500 Subject: [PATCH 3/8] Correcting CLI links and grammer changes --- website/content/api-docs/acl/auth-methods.mdx | 10 +++++----- website/content/api-docs/acl/binding-rules.mdx | 10 +++++----- website/content/api-docs/acl/index.mdx | 10 +++++----- website/content/api-docs/acl/policies.mdx | 12 ++++++------ website/content/api-docs/acl/roles.mdx | 12 ++++++------ website/content/api-docs/acl/tokens.mdx | 14 +++++++------- website/content/api-docs/agent/index.mdx | 14 +++++++------- website/content/api-docs/agent/service.mdx | 4 ++-- website/content/api-docs/catalog.mdx | 6 +++--- website/content/api-docs/config.mdx | 8 ++++---- website/content/api-docs/connect/ca.mdx | 4 ++-- .../content/api-docs/connect/intentions.mdx | 18 +++++++++--------- website/content/api-docs/coordinate.mdx | 4 ++-- website/content/api-docs/event.mdx | 2 +- website/content/api-docs/kv.mdx | 6 +++--- website/content/api-docs/namespaces.mdx | 10 +++++----- website/content/api-docs/operator/area.mdx | 12 ++++++------ .../content/api-docs/operator/autopilot.mdx | 6 +++--- website/content/api-docs/operator/keyring.mdx | 8 ++++---- website/content/api-docs/operator/license.mdx | 6 +++--- website/content/api-docs/operator/raft.mdx | 2 +- website/content/api-docs/snapshot.mdx | 4 ++-- website/content/api-docs/status.mdx | 2 +- 23 files changed, 92 insertions(+), 92 deletions(-) diff --git a/website/content/api-docs/acl/auth-methods.mdx b/website/content/api-docs/acl/auth-methods.mdx index 076d9d2c38..e68364db1a 100644 --- a/website/content/api-docs/acl/auth-methods.mdx +++ b/website/content/api-docs/acl/auth-methods.mdx @@ -34,7 +34,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -162,7 +162,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -216,7 +216,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -349,7 +349,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -393,7 +393,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 diff --git a/website/content/api-docs/acl/binding-rules.mdx b/website/content/api-docs/acl/binding-rules.mdx index 3375b2b412..ca3365f578 100644 --- a/website/content/api-docs/acl/binding-rules.mdx +++ b/website/content/api-docs/acl/binding-rules.mdx @@ -34,7 +34,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -160,7 +160,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -212,7 +212,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -344,7 +344,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -388,7 +388,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 diff --git a/website/content/api-docs/acl/index.mdx b/website/content/api-docs/acl/index.mdx index 162e9eb016..879f90ce12 100644 --- a/website/content/api-docs/acl/index.mdx +++ b/website/content/api-docs/acl/index.mdx @@ -38,7 +38,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -204,7 +204,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -253,7 +253,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -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 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 @@ -384,7 +384,7 @@ 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`](https://www.consul.io/commands/logout) +-> The corresponding CLI command is [`consul logout`](/commands/logout). ### Sample Request diff --git a/website/content/api-docs/acl/policies.mdx b/website/content/api-docs/acl/policies.mdx index 38c3c2e0a2..6c9edf95a3 100644 --- a/website/content/api-docs/acl/policies.mdx +++ b/website/content/api-docs/acl/policies.mdx @@ -33,7 +33,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -108,7 +108,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -160,7 +160,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `YES` | `all` | `none` | `acl:read` | --> The corresponding CLI command is [`consul acl policy read -name=`](https://www.consul.io/commands/acl/policy/read#name) +-> The corresponding CLI command is [`consul acl policy read -name=`](/commands/acl/policy/read#name). ### Parameters @@ -212,7 +212,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -293,7 +293,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -337,7 +337,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 diff --git a/website/content/api-docs/acl/roles.mdx b/website/content/api-docs/acl/roles.mdx index 84ef0a0f63..099d12da00 100644 --- a/website/content/api-docs/acl/roles.mdx +++ b/website/content/api-docs/acl/roles.mdx @@ -32,7 +32,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -174,7 +174,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -246,7 +246,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `YES` | `all` | `none` | `acl:read` | --> The corresponding CLI command is [`consul acl role read -name=`](https://www.consul.io/commands/acl/role/read#name) +-> The corresponding CLI command is [`consul acl role read -name=`](/commands/acl/role/read#name). ### Parameters @@ -317,7 +317,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -435,7 +435,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -479,7 +479,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 diff --git a/website/content/api-docs/acl/tokens.mdx b/website/content/api-docs/acl/tokens.mdx index 7554e6ebd6..af158127ce 100644 --- a/website/content/api-docs/acl/tokens.mdx +++ b/website/content/api-docs/acl/tokens.mdx @@ -32,7 +32,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -175,7 +175,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -247,7 +247,7 @@ 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`](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 @@ -299,7 +299,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -449,7 +449,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -530,7 +530,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -574,7 +574,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 diff --git a/website/content/api-docs/agent/index.mdx b/website/content/api-docs/agent/index.mdx index 9fe617015f..b472c67825 100644 --- a/website/content/api-docs/agent/index.mdx +++ b/website/content/api-docs/agent/index.mdx @@ -227,7 +227,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -375,7 +375,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------- | | `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 @@ -408,7 +408,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -635,7 +635,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------- | | `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 @@ -677,7 +677,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------- | | `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 @@ -716,7 +716,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `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 @@ -792,7 +792,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------- | | `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 diff --git a/website/content/api-docs/agent/service.mdx b/website/content/api-docs/agent/service.mdx index 78d83ac7fb..8c37c7d1a2 100644 --- a/website/content/api-docs/agent/service.mdx +++ b/website/content/api-docs/agent/service.mdx @@ -593,7 +593,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | --------------- | | `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 @@ -768,7 +768,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | --------------- | | `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 diff --git a/website/content/api-docs/catalog.mdx b/website/content/api-docs/catalog.mdx index 3c3503f74d..e685ce9fbd 100644 --- a/website/content/api-docs/catalog.mdx +++ b/website/content/api-docs/catalog.mdx @@ -266,7 +266,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -299,7 +299,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -396,7 +396,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | -------------- | | `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 diff --git a/website/content/api-docs/config.mdx b/website/content/api-docs/config.mdx index 56e5a8633b..24d3862834 100644 --- a/website/content/api-docs/config.mdx +++ b/website/content/api-docs/config.mdx @@ -48,7 +48,7 @@ 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`](https://www.consul.io/commands/config/write) +-> The corresponding CLI command is [`consul config write`](/commands/config/write). ### Parameters @@ -117,7 +117,7 @@ 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`](https://www.consul.io/commands/config/read) +-> The corresponding CLI command is [`consul config read`](/commands/config/read). ### Parameters @@ -188,7 +188,7 @@ 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`](https://www.consul.io/commands/config/list) +-> The corresponding CLI command is [`consul config list`](/commands/config/list). ### Parameters @@ -264,7 +264,7 @@ 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`](https://www.consul.io/commands/config/delete) +-> The corresponding CLI command is [`consul config delete`](/commands/config/delete). ### Parameters diff --git a/website/content/api-docs/connect/ca.mdx b/website/content/api-docs/connect/ca.mdx index 181c0cccc3..4804d362b0 100644 --- a/website/content/api-docs/connect/ca.mdx +++ b/website/content/api-docs/connect/ca.mdx @@ -125,7 +125,7 @@ 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`](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 @@ -167,7 +167,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `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 diff --git a/website/content/api-docs/connect/intentions.mdx b/website/content/api-docs/connect/intentions.mdx index 30d4f13638..5a93e75836 100644 --- a/website/content/api-docs/connect/intentions.mdx +++ b/website/content/api-docs/connect/intentions.mdx @@ -54,7 +54,7 @@ The table below shows this endpoint's support for for more details.

--> 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 @@ -165,7 +165,7 @@ The table below shows this endpoint's support for for more details.

--> 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 @@ -319,7 +319,7 @@ The table below shows this endpoint's support for for more details.

--> 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 @@ -396,7 +396,7 @@ The table below shows this endpoint's support for for more details.

--> 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 @@ -458,7 +458,7 @@ The table below shows this endpoint's support for for more details.

--> 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 @@ -549,7 +549,7 @@ The table below shows this endpoint's support for for more details.

--> 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 @@ -609,7 +609,7 @@ The table below shows this endpoint's support for for more details.

--> 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 @@ -666,7 +666,7 @@ The table below shows this endpoint's support for for more details.

--> 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 @@ -731,7 +731,7 @@ The table below shows this endpoint's support for for more details.

--> 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 diff --git a/website/content/api-docs/coordinate.mdx b/website/content/api-docs/coordinate.mdx index 6f2958095c..dc53ba3586 100644 --- a/website/content/api-docs/coordinate.mdx +++ b/website/content/api-docs/coordinate.mdx @@ -38,7 +38,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -92,7 +92,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 diff --git a/website/content/api-docs/event.mdx b/website/content/api-docs/event.mdx index 3a58f52fc3..fd835a0973 100644 --- a/website/content/api-docs/event.mdx +++ b/website/content/api-docs/event.mdx @@ -29,7 +29,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------- | | `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 diff --git a/website/content/api-docs/kv.mdx b/website/content/api-docs/kv.mdx index efdeee9074..63e62060ec 100644 --- a/website/content/api-docs/kv.mdx +++ b/website/content/api-docs/kv.mdx @@ -41,7 +41,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -173,7 +173,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -261,7 +261,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 diff --git a/website/content/api-docs/namespaces.mdx b/website/content/api-docs/namespaces.mdx index ad8b032cbf..1d3b49871d 100644 --- a/website/content/api-docs/namespaces.mdx +++ b/website/content/api-docs/namespaces.mdx @@ -29,7 +29,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `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 @@ -163,7 +163,7 @@ 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`](https://www.consul.io/commands/namespace/read) +-> The corresponding CLI command is [`consul namespace read`](/commands/namespace/read). ### Parameters @@ -231,7 +231,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `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 @@ -370,7 +370,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `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 @@ -444,7 +444,7 @@ 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`](https://www.consul.io/commands/namespace/list) +-> The corresponding CLI command is [`consul namespace list`](/commands/namespace/list). ### Sample Request diff --git a/website/content/api-docs/operator/area.mdx b/website/content/api-docs/operator/area.mdx index 6529dc2c33..e28fe41f0b 100644 --- a/website/content/api-docs/operator/area.mdx +++ b/website/content/api-docs/operator/area.mdx @@ -45,7 +45,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `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 @@ -113,7 +113,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | --------------- | | `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 @@ -158,7 +158,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `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 @@ -250,7 +250,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `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 @@ -288,7 +288,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `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 @@ -363,7 +363,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | --------------- | | `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 diff --git a/website/content/api-docs/operator/autopilot.mdx b/website/content/api-docs/operator/autopilot.mdx index 23ca9edc95..749e795f6c 100644 --- a/website/content/api-docs/operator/autopilot.mdx +++ b/website/content/api-docs/operator/autopilot.mdx @@ -33,7 +33,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | --------------- | | `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 @@ -89,7 +89,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `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 @@ -273,7 +273,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | --------------- | | `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 diff --git a/website/content/api-docs/operator/keyring.mdx b/website/content/api-docs/operator/keyring.mdx index a2def36ef7..b0dfef6081 100644 --- a/website/content/api-docs/operator/keyring.mdx +++ b/website/content/api-docs/operator/keyring.mdx @@ -35,7 +35,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | -------------- | | `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 @@ -122,7 +122,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | --------------- | | `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 @@ -170,7 +170,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | --------------- | | `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 @@ -218,7 +218,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | --------------- | | `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 diff --git a/website/content/api-docs/operator/license.mdx b/website/content/api-docs/operator/license.mdx index 467b88350c..b4853ad1ce 100644 --- a/website/content/api-docs/operator/license.mdx +++ b/website/content/api-docs/operator/license.mdx @@ -31,7 +31,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -98,7 +98,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `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 @@ -170,7 +170,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `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 diff --git a/website/content/api-docs/operator/raft.mdx b/website/content/api-docs/operator/raft.mdx index 04fbfa2ebd..3bd4dc4b8e 100644 --- a/website/content/api-docs/operator/raft.mdx +++ b/website/content/api-docs/operator/raft.mdx @@ -130,7 +130,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `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 diff --git a/website/content/api-docs/snapshot.mdx b/website/content/api-docs/snapshot.mdx index 9080389af1..b2866eae3c 100644 --- a/website/content/api-docs/snapshot.mdx +++ b/website/content/api-docs/snapshot.mdx @@ -39,7 +39,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 @@ -96,7 +96,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 diff --git a/website/content/api-docs/status.mdx b/website/content/api-docs/status.mdx index 30b0f45aeb..39df6eeca4 100644 --- a/website/content/api-docs/status.mdx +++ b/website/content/api-docs/status.mdx @@ -70,7 +70,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `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 From c20050c883dc82d0a2bb331048c3e31d12fe28d5 Mon Sep 17 00:00:00 2001 From: Chip Vaughn Date: Tue, 11 Jan 2022 11:26:05 -0500 Subject: [PATCH 4/8] Correcting CLI links and grammer changes part 2 --- website/content/api-docs/acl/auth-methods.mdx | 28 ++------------ .../content/api-docs/acl/binding-rules.mdx | 20 ---------- website/content/api-docs/acl/index.mdx | 20 ---------- website/content/api-docs/acl/policies.mdx | 24 ------------ website/content/api-docs/acl/roles.mdx | 24 ------------ website/content/api-docs/acl/tokens.mdx | 28 -------------- website/content/api-docs/agent/index.mdx | 28 -------------- website/content/api-docs/agent/service.mdx | 8 ---- website/content/api-docs/catalog.mdx | 12 ------ website/content/api-docs/config.mdx | 16 -------- website/content/api-docs/connect/ca.mdx | 8 ---- .../content/api-docs/connect/intentions.mdx | 38 +------------------ website/content/api-docs/coordinate.mdx | 8 ---- website/content/api-docs/event.mdx | 4 -- website/content/api-docs/kv.mdx | 12 ------ website/content/api-docs/namespaces.mdx | 20 ---------- website/content/api-docs/operator/area.mdx | 24 ------------ .../content/api-docs/operator/autopilot.mdx | 12 ------ website/content/api-docs/operator/keyring.mdx | 16 -------- website/content/api-docs/operator/license.mdx | 12 ------ website/content/api-docs/operator/raft.mdx | 4 -- website/content/api-docs/snapshot.mdx | 8 ---- website/content/api-docs/status.mdx | 4 -- 23 files changed, 5 insertions(+), 373 deletions(-) diff --git a/website/content/api-docs/acl/auth-methods.mdx b/website/content/api-docs/acl/auth-methods.mdx index 8409ae2ac7..799a5de42c 100644 --- a/website/content/api-docs/acl/auth-methods.mdx +++ b/website/content/api-docs/acl/auth-methods.mdx @@ -34,11 +34,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `acl:write` | -<<<<<<< HEAD --> 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) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 +-> The corresponding CLI command is [`consul acl auth-method create`](/commands/acl/auth-method/create). ### Parameters @@ -166,11 +162,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `YES` | `all` | `none` | `acl:read` | -<<<<<<< HEAD --> 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) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 +-> The corresponding CLI command is [`consul acl auth-method read`](/commands/acl/auth-method/read). ### Parameters @@ -224,11 +216,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `acl:write` | -<<<<<<< HEAD --> 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) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 +-> The corresponding CLI command is [`consul acl auth-method update`](/commands/acl/auth-method/update). ### Parameters @@ -361,11 +349,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `acl:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl auth-method delete`](/commands/acl/auth-method/delete). -======= --> The corresponding CLI command is [`consul acl auth-method delete`](https://www.consul.io/commands/acl/auth-method/delete) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -409,11 +393,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `YES` | `all` | `none` | `acl:read` | -<<<<<<< HEAD --> 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) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 +-> The corresponding CLI command is [`consul acl auth-method list`](/commands/acl/auth-method/list). ### Parameters diff --git a/website/content/api-docs/acl/binding-rules.mdx b/website/content/api-docs/acl/binding-rules.mdx index f5c3d9bee2..ca3365f578 100644 --- a/website/content/api-docs/acl/binding-rules.mdx +++ b/website/content/api-docs/acl/binding-rules.mdx @@ -34,11 +34,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `acl:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl binding-rule create`](/commands/acl/binding-rule/create). -======= --> The corresponding CLI command is [`consul acl binding-rule create`](https://www.consul.io/commands/acl/binding-rule/create) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -164,11 +160,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `YES` | `all` | `none` | `acl:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl binding-rule read`](/commands/acl/binding-rule/read). -======= --> The corresponding CLI command is [`consul acl binding-rule read`](https://www.consul.io/commands/acl/binding-rule/read) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -220,11 +212,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `acl:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl binding-rule update`](/commands/acl/binding-rule/update). -======= --> The corresponding CLI command is [`consul acl binding-rule update`](https://www.consul.io/commands/acl/binding-rule/update) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -356,11 +344,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `acl:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl binding-rule delete`](/commands/acl/binding-rule/delete). -======= --> The corresponding CLI command is [`consul acl binding-rule delete`](https://www.consul.io/commands/acl/binding-rule/delete) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -404,11 +388,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `YES` | `all` | `none` | `acl:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl binding-rule list`](/commands/acl/binding-rule/list). -======= --> The corresponding CLI command is [`consul acl binding-rule list`](https://www.consul.io/commands/acl/binding-rule/list) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ## Parameters diff --git a/website/content/api-docs/acl/index.mdx b/website/content/api-docs/acl/index.mdx index 963b66d741..879f90ce12 100644 --- a/website/content/api-docs/acl/index.mdx +++ b/website/content/api-docs/acl/index.mdx @@ -38,11 +38,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `none` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl bootstrap`](/commands/acl/bootstrap). -======= --> The corresponding CLI command is [`consul acl bootstrap`](https://www.consul.io/commands/acl/bootstrap) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Sample Request @@ -208,11 +204,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `acl:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl translate-rules`](/commands/acl/translate-rules). -======= --> The corresponding CLI command is [`consul acl translate-rules`](https://www.consul.io/commands/acl/translate-rules) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Sample Payload @@ -261,11 +253,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `acl:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl translate-rules`](/commands/acl/translate-rules). -======= --> The corresponding CLI command is [`consul acl translate-rules`](https://www.consul.io/commands/acl/translate-rules) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Sample Request @@ -308,11 +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 replication enabled. -<<<<<<< HEAD -> The corresponding CLI command is [`consul login`](/commands/login). -======= --> The corresponding CLI command is [`consul login`](https://www.consul.io/commands/login) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -400,11 +384,7 @@ 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. -<<<<<<< HEAD -> The corresponding CLI command is [`consul logout`](/commands/logout). -======= --> The corresponding CLI command is [`consul logout`](https://www.consul.io/commands/logout) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Sample Request diff --git a/website/content/api-docs/acl/policies.mdx b/website/content/api-docs/acl/policies.mdx index c687983807..6c9edf95a3 100644 --- a/website/content/api-docs/acl/policies.mdx +++ b/website/content/api-docs/acl/policies.mdx @@ -33,11 +33,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `acl:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl policy create`](/commands/acl/policy/create). -======= --> The corresponding CLI command is [`consul acl policy create`](https://www.consul.io/commands/acl/policy/create) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -112,11 +108,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `YES` | `all` | `none` | `acl:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl policy read`](/commands/acl/policy/read). -======= --> The corresponding CLI command is [`consul acl policy read`](https://www.consul.io/commands/acl/policy/read) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -168,11 +160,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `YES` | `all` | `none` | `acl:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl policy read -name=`](/commands/acl/policy/read#name). -======= --> The corresponding CLI command is [`consul acl policy read -name=`](https://www.consul.io/commands/acl/policy/read#name) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -224,11 +212,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `acl:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl policy update`](/commands/acl/policy/update). -======= --> The corresponding CLI command is [`consul acl policy update`](https://www.consul.io/commands/acl/policy/update) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -309,11 +293,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `acl:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl policy delete`](/commands/acl/policy/delete). -======= --> The corresponding CLI command is [`consul acl policy delete`](https://www.consul.io/commands/acl/policy/delete) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -357,11 +337,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `YES` | `all` | `none` | `acl:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl policy list`](/commands/acl/policy/list). -======= --> The corresponding CLI command is [`consul acl policy list`](https://www.consul.io/commands/acl/policy/list) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters diff --git a/website/content/api-docs/acl/roles.mdx b/website/content/api-docs/acl/roles.mdx index cab0ad1c12..099d12da00 100644 --- a/website/content/api-docs/acl/roles.mdx +++ b/website/content/api-docs/acl/roles.mdx @@ -32,11 +32,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `acl:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl role create`](/commands/acl/role/create). -======= --> The corresponding CLI command is [`consul acl role create`](https://www.consul.io/commands/acl/role/create) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -178,11 +174,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `YES` | `all` | `none` | `acl:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl role read`](/commands/acl/role/read). -======= --> The corresponding CLI command is [`consul acl role read`](https://www.consul.io/commands/acl/role/read) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -254,11 +246,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `YES` | `all` | `none` | `acl:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl role read -name=`](/commands/acl/role/read#name). -======= --> The corresponding CLI command is [`consul acl role read -name=`](https://www.consul.io/commands/acl/role/read#name) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -329,11 +317,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `acl:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl role update`](/commands/acl/role/update). -======= --> The corresponding CLI command is [`consul acl role update`](https://www.consul.io/commands/acl/role/update) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -451,11 +435,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `acl:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl role delete`](/commands/acl/role/delete). -======= --> The corresponding CLI command is [`consul acl role delete`](https://www.consul.io/commands/acl/role/delete) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -499,11 +479,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `YES` | `all` | `none` | `acl:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl role list`](/commands/acl/role/list). -======= --> The corresponding CLI command is [`consul acl role list`](https://www.consul.io/commands/acl/role/list) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ## Parameters diff --git a/website/content/api-docs/acl/tokens.mdx b/website/content/api-docs/acl/tokens.mdx index b3f0f2f5c2..af158127ce 100644 --- a/website/content/api-docs/acl/tokens.mdx +++ b/website/content/api-docs/acl/tokens.mdx @@ -32,11 +32,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `acl:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl token create`](/commands/acl/token/create). -======= --> The corresponding CLI command is [`consul acl token create`](https://www.consul.io/commands/acl/token/create) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -179,11 +175,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `YES` | `all` | `none` | `acl:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl token read`](/commands/acl/token/read). -======= --> The corresponding CLI command is [`consul acl token read`](https://www.consul.io/commands/acl/token/read) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -255,11 +247,7 @@ 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. -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl token read -self`](/commands/acl/token/read#self). -======= --> The corresponding CLI command is [`consul acl token read -self`](https://www.consul.io/commands/acl/token/read#self) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Sample Request @@ -311,11 +299,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `acl:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl token update`](/commands/acl/token/update). -======= --> The corresponding CLI command is [`consul acl token update`](https://www.consul.io/commands/acl/token/update) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -465,11 +449,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `acl:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl token clone`](/commands/acl/token/clone). -======= --> The corresponding CLI command is [`consul acl token clone`](https://www.consul.io/commands/acl/token/clone) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -550,11 +530,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `acl:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl token delete`](/commands/acl/token/delete). -======= --> The corresponding CLI command is [`consul acl token delete`](https://www.consul.io/commands/acl/token/delete) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -598,11 +574,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `YES` | `all` | `none` | `acl:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl token list`](/commands/acl/token/list). -======= --> The corresponding CLI command is [`consul acl token list`](https://www.consul.io/commands/acl/token/list) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ## Parameters diff --git a/website/content/api-docs/agent/index.mdx b/website/content/api-docs/agent/index.mdx index 5fd0fba7de..b472c67825 100644 --- a/website/content/api-docs/agent/index.mdx +++ b/website/content/api-docs/agent/index.mdx @@ -227,11 +227,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `node:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul members`](/commands/members). -======= --> The corresponding CLI command is [`consul members`](https://www.consul.io/commands/members) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -379,11 +375,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------- | | `NO` | `none` | `none` | `agent:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul reload`](/commands/reload). -======= --> The corresponding CLI command is [`consul reload`](https://www.consul.io/commands/reload) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Sample Request @@ -416,11 +408,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `node:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul maint`](/commands/maint). -======= --> The corresponding CLI command is [`consul maint`](https://www.consul.io/commands/maint) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -647,11 +635,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------- | | `NO` | `none` | `none` | `agent:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul join`](/commands/join). -======= --> The corresponding CLI command is [`consul join`](https://www.consul.io/commands/join) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -693,11 +677,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------- | | `NO` | `none` | `none` | `agent:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul leave`](/commands/leave). -======= --> The corresponding CLI command is [`consul leave`](https://www.consul.io/commands/leave) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Sample Request @@ -736,11 +716,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `NO` | `none` | `none` | `operator:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul force-leave`](/commands/force-leave). -======= --> The corresponding CLI command is [`consul force-leave`](https://www.consul.io/commands/force-leave) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -816,11 +792,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------- | | `NO` | `none` | `none` | `agent:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul acl set-agent-token`](/commands/acl/set-agent-token). -======= --> The corresponding CLI command is [`consul acl set-agent-token`](https://www.consul.io/commands/acl/set-agent-token) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters diff --git a/website/content/api-docs/agent/service.mdx b/website/content/api-docs/agent/service.mdx index 9abec0fa05..8c37c7d1a2 100644 --- a/website/content/api-docs/agent/service.mdx +++ b/website/content/api-docs/agent/service.mdx @@ -593,11 +593,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | --------------- | | `NO` | `none` | `none` | `service:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul services register`](/commands/services/register). -======= --> The corresponding CLI command is [`consul services register`](https://www.consul.io/commands/services/register) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Query string parameters @@ -772,11 +768,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | --------------- | | `NO` | `none` | `none` | `service:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul services deregister`](/commands/services/deregister). -======= --> The corresponding CLI command is [`consul services deregister`](https://www.consul.io/commands/services/deregister) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters diff --git a/website/content/api-docs/catalog.mdx b/website/content/api-docs/catalog.mdx index 5a48e23dd4..e685ce9fbd 100644 --- a/website/content/api-docs/catalog.mdx +++ b/website/content/api-docs/catalog.mdx @@ -266,11 +266,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `none` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul catalog datacenters`](/commands/catalog/datacenters). -======= --> The corresponding CLI command is [`consul catalog datacenters`](https://www.consul.io/commands/catalog/datacenters) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Sample Request @@ -303,11 +299,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `YES` | `all` | `none` | `node:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul catalog nodes`](/commands/catalog/nodes). -======= --> The corresponding CLI command is [`consul catalog nodes`](https://www.consul.io/commands/catalog/nodes) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -404,11 +396,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | -------------- | | `YES` | `all` | `none` | `service:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul catalog services`](/commands/catalog/services). -======= --> The corresponding CLI command is [`consul catalog services`](https://www.consul.io/commands/catalog/services) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters diff --git a/website/content/api-docs/config.mdx b/website/content/api-docs/config.mdx index e2a5707c21..24d3862834 100644 --- a/website/content/api-docs/config.mdx +++ b/website/content/api-docs/config.mdx @@ -48,11 +48,7 @@ The table below shows this endpoint's support for | service-splitter | `service:write` | | terminating-gateway | `operator:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul config write`](/commands/config/write). -======= --> The corresponding CLI command is [`consul config write`](https://www.consul.io/commands/config/write) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -121,11 +117,7 @@ The table below shows this endpoint's support for | service-splitter | `service:read` | | terminating-gateway | `service:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul config read`](/commands/config/read). -======= --> The corresponding CLI command is [`consul config read`](https://www.consul.io/commands/config/read) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -196,11 +188,7 @@ The table below shows this endpoint's support for | service-splitter | `service:read` | | terminating-gateway | `service:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul config list`](/commands/config/list). -======= --> The corresponding CLI command is [`consul config list`](https://www.consul.io/commands/config/list) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -276,11 +264,7 @@ The table below shows this endpoint's support for | service-splitter | `service:write` | | terminating-gateway | `operator:write ` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul config delete`](/commands/config/delete). -======= --> The corresponding CLI command is [`consul config delete`](https://www.consul.io/commands/config/delete) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters diff --git a/website/content/api-docs/connect/ca.mdx b/website/content/api-docs/connect/ca.mdx index ccad2a488d..4804d362b0 100644 --- a/website/content/api-docs/connect/ca.mdx +++ b/website/content/api-docs/connect/ca.mdx @@ -125,11 +125,7 @@ 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. -<<<<<<< HEAD -> The corresponding CLI command is [`consul connect ca get-config`](/commands/connect/ca#get-config). -======= --> The corresponding CLI command is [`consul connect ca get-config`](https://www.consul.io/commands/connect/ca#get-config) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Sample Request @@ -171,11 +167,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `NO` | `none` | `none` | `operator:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul connect ca set-config`](/commands/connect/ca#set-config). -======= --> The corresponding CLI command is [`consul connect ca set-config`](https://www.consul.io/commands/connect/ca#set-config) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters diff --git a/website/content/api-docs/connect/intentions.mdx b/website/content/api-docs/connect/intentions.mdx index 1401b8a8f7..8f34b65fa9 100644 --- a/website/content/api-docs/connect/intentions.mdx +++ b/website/content/api-docs/connect/intentions.mdx @@ -54,11 +54,7 @@ The table below shows this endpoint's support for for more details.

-<<<<<<< HEAD -> The corresponding CLI command is [`consul intention create -replace`](/commands/intention/create#replace). -======= --> The corresponding CLI command is [`consul intention create -replace`](https://www.consul.io/commands/intention/create#replace) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### URL Parameters @@ -169,11 +165,7 @@ The table below shows this endpoint's support for for more details.

-<<<<<<< HEAD -> The corresponding CLI command is [`consul intention create`](/commands/intention/create). -======= --> The corresponding CLI command is [`consul intention create`](https://www.consul.io/commands/intention/create) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### URL Parameters @@ -327,11 +319,7 @@ The table below shows this endpoint's support for for more details.

-<<<<<<< HEAD -> The corresponding CLI command is [`consul intention create`](/commands/intention/get). -======= --> The corresponding CLI command is [`consul intention create`](https://www.consul.io/commands/intention/get) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -408,11 +396,7 @@ The table below shows this endpoint's support for for more details.

-<<<<<<< HEAD -> The corresponding CLI command is [`consul intention create`](/commands/intention/get). -======= --> The corresponding CLI command is [`consul intention create`](https://www.consul.io/commands/intention/get) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -474,11 +458,7 @@ The table below shows this endpoint's support for for more details.

-<<<<<<< HEAD --> The corresponding CLI command is [`consul intention create`](/commands/intention/get). -======= --> The corresponding CLI command is [`consul intention create`](https://www.consul.io/commands/intention/get) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 +-> The corresponding CLI command is `consul intention list`. ### Parameters @@ -569,11 +549,7 @@ The table below shows this endpoint's support for for more details.

-<<<<<<< HEAD -> The corresponding CLI command is [`consul intention delete`](/commands/intention/delete). -======= --> The corresponding CLI command is [`consul intention delete`](https://www.consul.io/commands/intention/delete) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -633,11 +609,7 @@ The table below shows this endpoint's support for for more details.

-<<<<<<< HEAD -> The corresponding CLI command is [`consul intention delete`](/commands/intention/delete). -======= --> The corresponding CLI command is [`consul intention delete`](https://www.consul.io/commands/intention/delete) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -694,11 +666,7 @@ The table below shows this endpoint's support for for more details.

-<<<<<<< HEAD -> The corresponding CLI command is [`consul intention check`](/commands/intention/check). -======= --> The corresponding CLI command is [`consul intention check`](https://www.consul.io/commands/intention/check) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -763,11 +731,7 @@ The table below shows this endpoint's support for for more details.

-<<<<<<< HEAD -> The corresponding CLI command is [`consul intention match`](/commands/intention/match). -======= --> The corresponding CLI command is [`consul intention match`](https://www.consul.io/commands/intention/match) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters diff --git a/website/content/api-docs/coordinate.mdx b/website/content/api-docs/coordinate.mdx index c51dc0bd1e..dc53ba3586 100644 --- a/website/content/api-docs/coordinate.mdx +++ b/website/content/api-docs/coordinate.mdx @@ -38,11 +38,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `none` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul rtt -wan #`](/commands/rtt#wan). -======= --> The corresponding CLI command is [`consul rtt -wan #`](https://www.consul.io/commands/rtt#wan) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Sample Request @@ -96,11 +92,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `YES` | `all` | `none` | `node:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul rtt #`](/commands/rtt). -======= --> The corresponding CLI command is [`consul rtt #`](https://www.consul.io/commands/rtt) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters diff --git a/website/content/api-docs/event.mdx b/website/content/api-docs/event.mdx index e72c5aab48..fd835a0973 100644 --- a/website/content/api-docs/event.mdx +++ b/website/content/api-docs/event.mdx @@ -29,11 +29,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------- | | `NO` | `none` | `none` | `event:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul event`](/commands/event). -======= --> The corresponding CLI command is [`consul event`](https://www.consul.io/commands/event) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters diff --git a/website/content/api-docs/kv.mdx b/website/content/api-docs/kv.mdx index 70a533c855..63e62060ec 100644 --- a/website/content/api-docs/kv.mdx +++ b/website/content/api-docs/kv.mdx @@ -41,11 +41,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `YES` | `all` | `none` | `key:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul kv get`](/commands/kv/get). -======= --> The corresponding CLI command is [`consul kv get`](https://www.consul.io/commands/kv/get) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -177,11 +173,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `key:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul kv put`](/commands/kv/put). -======= --> The corresponding CLI command is [`consul kv put`](https://www.consul.io/commands/kv/put) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -269,11 +261,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `key:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul kv delete`](/commands/kv/delete). -======= --> The corresponding CLI command is [`consul kv delete`](https://www.consul.io/commands/kv/delete) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters diff --git a/website/content/api-docs/namespaces.mdx b/website/content/api-docs/namespaces.mdx index 6660a7b8f2..1d3b49871d 100644 --- a/website/content/api-docs/namespaces.mdx +++ b/website/content/api-docs/namespaces.mdx @@ -29,11 +29,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `NO` | `none` | `none` | `operator:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul namespace create`](/commands/namespace/create). -======= --> The corresponding CLI command is [`consul namespace create`](https://www.consul.io/commands/namespace/create) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -167,11 +163,7 @@ 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). -<<<<<<< HEAD -> The corresponding CLI command is [`consul namespace read`](/commands/namespace/read). -======= --> The corresponding CLI command is [`consul namespace read`](https://www.consul.io/commands/namespace/read) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -239,11 +231,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `NO` | `none` | `none` | `operator:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul namespace update`](/commands/namespace/update) or [`consul namespace write`](/commands/namespace/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) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -382,11 +370,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `NO` | `none` | `none` | `operator:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul namespace delete`](/commands/namespace/delete). -======= --> The corresponding CLI command is [`consul namespace delete`](https://www.consul.io/commands/namespace/delete) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -460,11 +444,7 @@ 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). -<<<<<<< HEAD -> The corresponding CLI command is [`consul namespace list`](/commands/namespace/list). -======= --> The corresponding CLI command is [`consul namespace list`](https://www.consul.io/commands/namespace/list) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Sample Request diff --git a/website/content/api-docs/operator/area.mdx b/website/content/api-docs/operator/area.mdx index cb7afed1f1..e28fe41f0b 100644 --- a/website/content/api-docs/operator/area.mdx +++ b/website/content/api-docs/operator/area.mdx @@ -45,11 +45,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `NO` | `none` | `none` | `operator:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul operator area create`](/commands/operator/area#create). -======= --> The corresponding CLI command is [`consul operator area create`](https://www.consul.io/commands/operator/area#create) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -117,11 +113,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | --------------- | | `YES` | `all` | `none` | `operator:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul operator area list`](/commands/operator/area#list). -======= --> The corresponding CLI command is [`consul operator area list`](https://www.consul.io/commands/operator/area#list) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -166,11 +158,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `NO` | `none` | `none` | `operator:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul operator area update`](/commands/operator/area#update). -======= --> The corresponding CLI command is [`consul operator area update`](https://www.consul.io/commands/operator/area#update) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -262,11 +250,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `NO` | `none` | `none` | `operator:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul operator area delete`](/commands/operator/area#delete). -======= --> The corresponding CLI command is [`consul operator area delete`](https://www.consul.io/commands/operator/area#delete) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -304,11 +288,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `NO` | `none` | `none` | `operator:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul operator area join`](/commands/operator/area#join). -======= --> The corresponding CLI command is [`consul operator area join`](https://www.consul.io/commands/operator/area#join) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -383,11 +363,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | --------------- | | `NO` | `none` | `none` | `operator:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul operator area members`](/commands/operator/area#members). -======= --> The corresponding CLI command is [`consul operator area members`](https://www.consul.io/commands/operator/area#members) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters diff --git a/website/content/api-docs/operator/autopilot.mdx b/website/content/api-docs/operator/autopilot.mdx index 15d2738fa0..749e795f6c 100644 --- a/website/content/api-docs/operator/autopilot.mdx +++ b/website/content/api-docs/operator/autopilot.mdx @@ -33,11 +33,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | --------------- | | `NO` | `none` | `none` | `operator:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul operator autopilot get-config`](/commands/operator/autopilot#get-config). -======= --> The corresponding CLI command is [`consul operator autopilot get-config`](https://www.consul.io/commands/operator/autopilot#get-config) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -93,11 +89,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `NO` | `none` | `none` | `operator:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul operator autopilot set-config`](/commands/operator/autopilot#set-config). -======= --> The corresponding CLI command is [`consul operator autopilot set-config`](https://www.consul.io/commands/operator/autopilot#set-config) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -281,11 +273,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | --------------- | | `NO` | `none` | `none` | `operator:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul operator autopilot state`](/commands/operator/autopilot#state). -======= --> The corresponding CLI command is [`consul operator autopilot state`](https://www.consul.io/commands/operator/autopilot#state) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters diff --git a/website/content/api-docs/operator/keyring.mdx b/website/content/api-docs/operator/keyring.mdx index de8f37b155..b0dfef6081 100644 --- a/website/content/api-docs/operator/keyring.mdx +++ b/website/content/api-docs/operator/keyring.mdx @@ -35,11 +35,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | -------------- | | `NO` | `none` | `none` | `keyring:read` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul keyring -list`](/commands/keyring#list). -======= --> The corresponding CLI command is [`consul keyring -list`](https://www.consul.io/commands/keyring#list) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -126,11 +122,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | --------------- | | `NO` | `none` | `none` | `keyring:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul keyring -intstall`](/commands/keyring#install). -======= --> The corresponding CLI command is [`consul keyring -intstall`](https://www.consul.io/commands/keyring#install) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -178,11 +170,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | --------------- | | `NO` | `none` | `none` | `keyring:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul keyring -use`](/commands/keyring#use). -======= --> The corresponding CLI command is [`consul keyring -use`](https://www.consul.io/commands/keyring#use) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -230,11 +218,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | --------------- | | `NO` | `none` | `none` | `keyring:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul keyring -remove`](/commands/keyring#remove). -======= --> The corresponding CLI command is [`consul keyring -remove`](https://www.consul.io/commands/keyring#remove) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters diff --git a/website/content/api-docs/operator/license.mdx b/website/content/api-docs/operator/license.mdx index 7766393b0c..b4853ad1ce 100644 --- a/website/content/api-docs/operator/license.mdx +++ b/website/content/api-docs/operator/license.mdx @@ -31,11 +31,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `all` | `none` | `none` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul license get`](/commands/license#get). -======= --> The corresponding CLI command is [`consul license get`](https://www.consul.io/commands/license#get) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -102,11 +98,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `NO` | `none` | `none` | `operator:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul license put`](/commands/license#put). -======= --> The corresponding CLI command is [`consul license put`](https://www.consul.io/commands/license#put) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -178,11 +170,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `NO` | `none` | `none` | `operator:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul license reset`](/commands/license#reset). -======= --> The corresponding CLI command is [`consul license reset`](https://www.consul.io/commands/license#reset) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters diff --git a/website/content/api-docs/operator/raft.mdx b/website/content/api-docs/operator/raft.mdx index 4bd3754478..3bd4dc4b8e 100644 --- a/website/content/api-docs/operator/raft.mdx +++ b/website/content/api-docs/operator/raft.mdx @@ -130,11 +130,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ---------------- | | `NO` | `none` | `none` | `operator:write` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul operator raft remove-peer`](/commands/operator/raft#remove-peer). -======= --> The corresponding CLI command is [`consul operator raft remove-peer`](https://www.consul.io/commands/operator/raft#remove-peer) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters diff --git a/website/content/api-docs/snapshot.mdx b/website/content/api-docs/snapshot.mdx index 2556ab134f..b2866eae3c 100644 --- a/website/content/api-docs/snapshot.mdx +++ b/website/content/api-docs/snapshot.mdx @@ -39,11 +39,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `default,stale` | `none` | `management` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul snapshot save`](/commands/snapshot/save). -======= --> The corresponding CLI command is [`consul snapshot save`](https://www.consul.io/commands/snapshot/save) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters @@ -100,11 +96,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `management` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul snapshot restore`](/commands/snapshot/restore). -======= --> The corresponding CLI command is [`consul snapshot restore`](https://www.consul.io/commands/snapshot/restore) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters diff --git a/website/content/api-docs/status.mdx b/website/content/api-docs/status.mdx index 3bff750ae8..39df6eeca4 100644 --- a/website/content/api-docs/status.mdx +++ b/website/content/api-docs/status.mdx @@ -70,11 +70,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `none` | -<<<<<<< HEAD -> The corresponding CLI command is [`consul operator raft list-peers`](/commands/operator/raft#list-peers). -======= --> The corresponding CLI command is [`consul operator raft list-peers`](https://www.consul.io/commands/operator/raft#list-peers) ->>>>>>> f3587417d0a80537b28263338c32bfd840714733 ### Parameters From 47067b0256d9c61a4826df447b1b0f1fbe093dc7 Mon Sep 17 00:00:00 2001 From: Chip Vaughn Date: Tue, 11 Jan 2022 11:46:50 -0500 Subject: [PATCH 5/8] Fixing CircleCI issues and adding Partition CLI links --- website/content/api-docs/admin-partitions.mdx | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/website/content/api-docs/admin-partitions.mdx b/website/content/api-docs/admin-partitions.mdx index adf2e0529d..a9129ed890 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 From 2b3fa23425662fb2903aee489b172d76c05f4431 Mon Sep 17 00:00:00 2001 From: Chip Vaughn Date: Tue, 11 Jan 2022 15:51:04 -0500 Subject: [PATCH 6/8] CLI Link clean-up --- website/content/api-docs/connect/intentions.mdx | 4 ++-- website/content/api-docs/coordinate.mdx | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/website/content/api-docs/connect/intentions.mdx b/website/content/api-docs/connect/intentions.mdx index 8f34b65fa9..7afdb026d9 100644 --- a/website/content/api-docs/connect/intentions.mdx +++ b/website/content/api-docs/connect/intentions.mdx @@ -319,7 +319,7 @@ The table below shows this endpoint's support for for more details.

--> The corresponding CLI command is [`consul intention create`](/commands/intention/get). +-> The corresponding CLI command is [`consul intention get`](/commands/intention/get). ### Parameters @@ -396,7 +396,7 @@ The table below shows this endpoint's support for for more details.

--> The corresponding CLI command is [`consul intention create`](/commands/intention/get). +-> The corresponding CLI command is [`consul intention get`](/commands/intention/get). ### Parameters diff --git a/website/content/api-docs/coordinate.mdx b/website/content/api-docs/coordinate.mdx index dc53ba3586..e9103a1166 100644 --- a/website/content/api-docs/coordinate.mdx +++ b/website/content/api-docs/coordinate.mdx @@ -38,7 +38,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `none` | --> The corresponding CLI command is [`consul rtt -wan #`](/commands/rtt#wan). +-> The corresponding CLI command is [`consul rtt -wan`](/commands/rtt#wan). ### Sample Request @@ -92,7 +92,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `YES` | `all` | `none` | `node:read` | --> The corresponding CLI command is [`consul rtt #`](/commands/rtt). +-> The corresponding CLI command is [`consul rtt`](/commands/rtt). ### Parameters From 0675b30e8670f50821bd4839275199302aac429f Mon Sep 17 00:00:00 2001 From: Jared Kirschner Date: Sat, 15 Jan 2022 09:29:35 -0800 Subject: [PATCH 7/8] docs: don't treat CLI cmd cross-ref as info box --- website/content/api-docs/acl/auth-methods.mdx | 10 +++++----- website/content/api-docs/acl/binding-rules.mdx | 10 +++++----- website/content/api-docs/acl/index.mdx | 10 +++++----- website/content/api-docs/acl/policies.mdx | 12 ++++++------ website/content/api-docs/acl/roles.mdx | 12 ++++++------ website/content/api-docs/acl/tokens.mdx | 14 +++++++------- website/content/api-docs/admin-partitions.mdx | 10 +++++----- website/content/api-docs/agent/index.mdx | 14 +++++++------- website/content/api-docs/agent/service.mdx | 4 ++-- website/content/api-docs/catalog.mdx | 6 +++--- website/content/api-docs/config.mdx | 8 ++++---- website/content/api-docs/connect/ca.mdx | 4 ++-- .../content/api-docs/connect/intentions.mdx | 18 +++++++++--------- website/content/api-docs/coordinate.mdx | 4 ++-- website/content/api-docs/event.mdx | 2 +- website/content/api-docs/kv.mdx | 6 +++--- website/content/api-docs/namespaces.mdx | 10 +++++----- website/content/api-docs/operator/area.mdx | 12 ++++++------ .../content/api-docs/operator/autopilot.mdx | 6 +++--- website/content/api-docs/operator/keyring.mdx | 8 ++++---- website/content/api-docs/operator/license.mdx | 6 +++--- website/content/api-docs/operator/raft.mdx | 2 +- website/content/api-docs/snapshot.mdx | 4 ++-- website/content/api-docs/status.mdx | 2 +- 24 files changed, 97 insertions(+), 97 deletions(-) diff --git a/website/content/api-docs/acl/auth-methods.mdx b/website/content/api-docs/acl/auth-methods.mdx index 799a5de42c..ab5a07646a 100644 --- a/website/content/api-docs/acl/auth-methods.mdx +++ b/website/content/api-docs/acl/auth-methods.mdx @@ -34,7 +34,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `acl:write` | --> The corresponding CLI command is [`consul acl auth-method create`](/commands/acl/auth-method/create). +The corresponding CLI command is [`consul acl auth-method create`](/commands/acl/auth-method/create). ### Parameters @@ -162,7 +162,7 @@ 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). +The corresponding CLI command is [`consul acl auth-method read`](/commands/acl/auth-method/read). ### Parameters @@ -216,7 +216,7 @@ 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). +The corresponding CLI command is [`consul acl auth-method update`](/commands/acl/auth-method/update). ### Parameters @@ -349,7 +349,7 @@ 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). +The corresponding CLI command is [`consul acl auth-method delete`](/commands/acl/auth-method/delete). ### Parameters @@ -393,7 +393,7 @@ 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). +The corresponding CLI command is [`consul acl auth-method list`](/commands/acl/auth-method/list). ### Parameters diff --git a/website/content/api-docs/acl/binding-rules.mdx b/website/content/api-docs/acl/binding-rules.mdx index ca3365f578..20c8196db5 100644 --- a/website/content/api-docs/acl/binding-rules.mdx +++ b/website/content/api-docs/acl/binding-rules.mdx @@ -34,7 +34,7 @@ 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). +The corresponding CLI command is [`consul acl binding-rule create`](/commands/acl/binding-rule/create). ### Parameters @@ -160,7 +160,7 @@ 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). +The corresponding CLI command is [`consul acl binding-rule read`](/commands/acl/binding-rule/read). ### Parameters @@ -212,7 +212,7 @@ 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). +The corresponding CLI command is [`consul acl binding-rule update`](/commands/acl/binding-rule/update). ### Parameters @@ -344,7 +344,7 @@ 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). +The corresponding CLI command is [`consul acl binding-rule delete`](/commands/acl/binding-rule/delete). ### Parameters @@ -388,7 +388,7 @@ 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). +The corresponding CLI command is [`consul acl binding-rule list`](/commands/acl/binding-rule/list). ## Parameters diff --git a/website/content/api-docs/acl/index.mdx b/website/content/api-docs/acl/index.mdx index 879f90ce12..ddae6cfab1 100644 --- a/website/content/api-docs/acl/index.mdx +++ b/website/content/api-docs/acl/index.mdx @@ -38,7 +38,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `none` | --> The corresponding CLI command is [`consul acl bootstrap`](/commands/acl/bootstrap). +The corresponding CLI command is [`consul acl bootstrap`](/commands/acl/bootstrap). ### Sample Request @@ -204,7 +204,7 @@ 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). +The corresponding CLI command is [`consul acl translate-rules`](/commands/acl/translate-rules). ### Sample Payload @@ -253,7 +253,7 @@ 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). +The corresponding CLI command is [`consul acl translate-rules`](/commands/acl/translate-rules). ### 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 replication enabled. --> The corresponding CLI command is [`consul login`](/commands/login). +The corresponding CLI command is [`consul login`](/commands/login). ### 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 deleting a token for which you already must possess its secret. --> The corresponding CLI command is [`consul logout`](/commands/logout). +The corresponding CLI command is [`consul logout`](/commands/logout). ### Sample Request diff --git a/website/content/api-docs/acl/policies.mdx b/website/content/api-docs/acl/policies.mdx index 6c9edf95a3..77a1d2ce5c 100644 --- a/website/content/api-docs/acl/policies.mdx +++ b/website/content/api-docs/acl/policies.mdx @@ -33,7 +33,7 @@ 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). +The corresponding CLI command is [`consul acl policy create`](/commands/acl/policy/create). ### Parameters @@ -108,7 +108,7 @@ 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). +The corresponding CLI command is [`consul acl policy read`](/commands/acl/policy/read). ### Parameters @@ -160,7 +160,7 @@ 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). +The corresponding CLI command is [`consul acl policy read -name=`](/commands/acl/policy/read#name). ### Parameters @@ -212,7 +212,7 @@ 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). +The corresponding CLI command is [`consul acl policy update`](/commands/acl/policy/update). ### Parameters @@ -293,7 +293,7 @@ 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). +The corresponding CLI command is [`consul acl policy delete`](/commands/acl/policy/delete). ### Parameters @@ -337,7 +337,7 @@ 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). +The corresponding CLI command is [`consul acl policy list`](/commands/acl/policy/list). ### Parameters diff --git a/website/content/api-docs/acl/roles.mdx b/website/content/api-docs/acl/roles.mdx index 099d12da00..29beb3fa78 100644 --- a/website/content/api-docs/acl/roles.mdx +++ b/website/content/api-docs/acl/roles.mdx @@ -32,7 +32,7 @@ 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). +The corresponding CLI command is [`consul acl role create`](/commands/acl/role/create). ### Parameters @@ -174,7 +174,7 @@ 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). +The corresponding CLI command is [`consul acl role read`](/commands/acl/role/read). ### Parameters @@ -246,7 +246,7 @@ 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). +The corresponding CLI command is [`consul acl role read -name=`](/commands/acl/role/read#name). ### Parameters @@ -317,7 +317,7 @@ 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). +The corresponding CLI command is [`consul acl role update`](/commands/acl/role/update). ### Parameters @@ -435,7 +435,7 @@ 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). +The corresponding CLI command is [`consul acl role delete`](/commands/acl/role/delete). ### Parameters @@ -479,7 +479,7 @@ 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). +The corresponding CLI command is [`consul acl role list`](/commands/acl/role/list). ## Parameters diff --git a/website/content/api-docs/acl/tokens.mdx b/website/content/api-docs/acl/tokens.mdx index af158127ce..9e457589bf 100644 --- a/website/content/api-docs/acl/tokens.mdx +++ b/website/content/api-docs/acl/tokens.mdx @@ -32,7 +32,7 @@ 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). +The corresponding CLI command is [`consul acl token create`](/commands/acl/token/create). ### Parameters @@ -175,7 +175,7 @@ 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). +The corresponding CLI command is [`consul acl token read`](/commands/acl/token/read). ### 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 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). +The corresponding CLI command is [`consul acl token read -self`](/commands/acl/token/read#self). ### Sample Request @@ -299,7 +299,7 @@ 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). +The corresponding CLI command is [`consul acl token update`](/commands/acl/token/update). ### Parameters @@ -449,7 +449,7 @@ 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). +The corresponding CLI command is [`consul acl token clone`](/commands/acl/token/clone). ### Parameters @@ -530,7 +530,7 @@ 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). +The corresponding CLI command is [`consul acl token delete`](/commands/acl/token/delete). ### Parameters @@ -574,7 +574,7 @@ 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). +The corresponding CLI command is [`consul acl token list`](/commands/acl/token/list). ## Parameters diff --git a/website/content/api-docs/admin-partitions.mdx b/website/content/api-docs/admin-partitions.mdx index a9129ed890..e808861603 100644 --- a/website/content/api-docs/admin-partitions.mdx +++ b/website/content/api-docs/admin-partitions.mdx @@ -29,7 +29,7 @@ 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). +The corresponding CLI command is [`consul partition create`](/commands/partition#create). ### Parameters @@ -87,7 +87,7 @@ 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). +The corresponding CLI command is [`consul partition read`](/commands/partition#read). ### Parameters @@ -130,7 +130,7 @@ 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). +The corresponding CLI command is [`consul partition write`](/commands/partition#write). ### Parameters @@ -194,7 +194,7 @@ 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). +The corresponding CLI command is [`consul partition delete`](/commands/partition#delete). ### Parameters @@ -239,7 +239,7 @@ 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). +The corresponding CLI command is [`consul partition list`](/commands/partition#list). ### Sample Request diff --git a/website/content/api-docs/agent/index.mdx b/website/content/api-docs/agent/index.mdx index b472c67825..899949f372 100644 --- a/website/content/api-docs/agent/index.mdx +++ b/website/content/api-docs/agent/index.mdx @@ -227,7 +227,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `node:read` | --> The corresponding CLI command is [`consul members`](/commands/members). +The corresponding CLI command is [`consul members`](/commands/members). ### Parameters @@ -375,7 +375,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------- | | `NO` | `none` | `none` | `agent:write` | --> The corresponding CLI command is [`consul reload`](/commands/reload). +The corresponding CLI command is [`consul reload`](/commands/reload). ### Sample Request @@ -408,7 +408,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `node:write` | --> The corresponding CLI command is [`consul maint`](/commands/maint). +The corresponding CLI command is [`consul maint`](/commands/maint). ### Parameters @@ -635,7 +635,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------- | | `NO` | `none` | `none` | `agent:write` | --> The corresponding CLI command is [`consul join`](/commands/join). +The corresponding CLI command is [`consul join`](/commands/join). ### Parameters @@ -677,7 +677,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------- | | `NO` | `none` | `none` | `agent:write` | --> The corresponding CLI command is [`consul leave`](/commands/leave). +The corresponding CLI command is [`consul leave`](/commands/leave). ### Sample Request @@ -716,7 +716,7 @@ 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). +The corresponding CLI command is [`consul force-leave`](/commands/force-leave). ### Parameters @@ -792,7 +792,7 @@ 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). +The corresponding CLI command is [`consul acl set-agent-token`](/commands/acl/set-agent-token). ### Parameters diff --git a/website/content/api-docs/agent/service.mdx b/website/content/api-docs/agent/service.mdx index 8c37c7d1a2..d870eae23d 100644 --- a/website/content/api-docs/agent/service.mdx +++ b/website/content/api-docs/agent/service.mdx @@ -593,7 +593,7 @@ 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). +The corresponding CLI command is [`consul services register`](/commands/services/register). ### Query string parameters @@ -768,7 +768,7 @@ 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). +The corresponding CLI command is [`consul services deregister`](/commands/services/deregister). ### Parameters diff --git a/website/content/api-docs/catalog.mdx b/website/content/api-docs/catalog.mdx index e685ce9fbd..f1e9c7fe4e 100644 --- a/website/content/api-docs/catalog.mdx +++ b/website/content/api-docs/catalog.mdx @@ -266,7 +266,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `none` | --> The corresponding CLI command is [`consul catalog datacenters`](/commands/catalog/datacenters). +The corresponding CLI command is [`consul catalog datacenters`](/commands/catalog/datacenters). ### Sample Request @@ -299,7 +299,7 @@ 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). +The corresponding CLI command is [`consul catalog nodes`](/commands/catalog/nodes). ### Parameters @@ -396,7 +396,7 @@ 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). +The corresponding CLI command is [`consul catalog services`](/commands/catalog/services). ### Parameters diff --git a/website/content/api-docs/config.mdx b/website/content/api-docs/config.mdx index 24d3862834..c8ea8172b4 100644 --- a/website/content/api-docs/config.mdx +++ b/website/content/api-docs/config.mdx @@ -48,7 +48,7 @@ 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). +The corresponding CLI command is [`consul config write`](/commands/config/write). ### Parameters @@ -117,7 +117,7 @@ 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). +The corresponding CLI command is [`consul config read`](/commands/config/read). ### Parameters @@ -188,7 +188,7 @@ 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). +The corresponding CLI command is [`consul config list`](/commands/config/list). ### Parameters @@ -264,7 +264,7 @@ 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). +The corresponding CLI command is [`consul config delete`](/commands/config/delete). ### Parameters diff --git a/website/content/api-docs/connect/ca.mdx b/website/content/api-docs/connect/ca.mdx index 4804d362b0..90a49d8c6d 100644 --- a/website/content/api-docs/connect/ca.mdx +++ b/website/content/api-docs/connect/ca.mdx @@ -125,7 +125,7 @@ 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). +The corresponding CLI command is [`consul connect ca get-config`](/commands/connect/ca#get-config). ### Sample Request @@ -167,7 +167,7 @@ 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). +The corresponding CLI command is [`consul connect ca set-config`](/commands/connect/ca#set-config). ### Parameters diff --git a/website/content/api-docs/connect/intentions.mdx b/website/content/api-docs/connect/intentions.mdx index 7afdb026d9..d6458073a8 100644 --- a/website/content/api-docs/connect/intentions.mdx +++ b/website/content/api-docs/connect/intentions.mdx @@ -54,7 +54,7 @@ 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). +The corresponding CLI command is [`consul intention create -replace`](/commands/intention/create#replace). ### URL Parameters @@ -165,7 +165,7 @@ The table below shows this endpoint's support for for more details.

--> The corresponding CLI command is [`consul intention create`](/commands/intention/create). +The corresponding CLI command is [`consul intention create`](/commands/intention/create). ### URL Parameters @@ -319,7 +319,7 @@ The table below shows this endpoint's support for for more details.

--> The corresponding CLI command is [`consul intention get`](/commands/intention/get). +The corresponding CLI command is [`consul intention get`](/commands/intention/get). ### Parameters @@ -396,7 +396,7 @@ The table below shows this endpoint's support for for more details.

--> The corresponding CLI command is [`consul intention get`](/commands/intention/get). +The corresponding CLI command is [`consul intention get`](/commands/intention/get). ### Parameters @@ -458,7 +458,7 @@ The table below shows this endpoint's support for for more details.

--> The corresponding CLI command is `consul intention list`. +The corresponding CLI command is `consul intention list`. ### Parameters @@ -549,7 +549,7 @@ The table below shows this endpoint's support for for more details.

--> The corresponding CLI command is [`consul intention delete`](/commands/intention/delete). +The corresponding CLI command is [`consul intention delete`](/commands/intention/delete). ### Parameters @@ -609,7 +609,7 @@ The table below shows this endpoint's support for for more details.

--> The corresponding CLI command is [`consul intention delete`](/commands/intention/delete). +The corresponding CLI command is [`consul intention delete`](/commands/intention/delete). ### Parameters @@ -666,7 +666,7 @@ The table below shows this endpoint's support for for more details.

--> The corresponding CLI command is [`consul intention check`](/commands/intention/check). +The corresponding CLI command is [`consul intention check`](/commands/intention/check). ### Parameters @@ -731,7 +731,7 @@ The table below shows this endpoint's support for for more details.

--> The corresponding CLI command is [`consul intention match`](/commands/intention/match). +The corresponding CLI command is [`consul intention match`](/commands/intention/match). ### Parameters diff --git a/website/content/api-docs/coordinate.mdx b/website/content/api-docs/coordinate.mdx index e9103a1166..f3328d5515 100644 --- a/website/content/api-docs/coordinate.mdx +++ b/website/content/api-docs/coordinate.mdx @@ -38,7 +38,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `none` | --> The corresponding CLI command is [`consul rtt -wan`](/commands/rtt#wan). +The corresponding CLI command is [`consul rtt -wan`](/commands/rtt#wan). ### Sample Request @@ -92,7 +92,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `YES` | `all` | `none` | `node:read` | --> The corresponding CLI command is [`consul rtt`](/commands/rtt). +The corresponding CLI command is [`consul rtt`](/commands/rtt). ### Parameters diff --git a/website/content/api-docs/event.mdx b/website/content/api-docs/event.mdx index fd835a0973..47ec7345d8 100644 --- a/website/content/api-docs/event.mdx +++ b/website/content/api-docs/event.mdx @@ -29,7 +29,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------- | | `NO` | `none` | `none` | `event:write` | --> The corresponding CLI command is [`consul event`](/commands/event). +The corresponding CLI command is [`consul event`](/commands/event). ### Parameters diff --git a/website/content/api-docs/kv.mdx b/website/content/api-docs/kv.mdx index 63e62060ec..aa7c38670a 100644 --- a/website/content/api-docs/kv.mdx +++ b/website/content/api-docs/kv.mdx @@ -41,7 +41,7 @@ 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). +The corresponding CLI command is [`consul kv get`](/commands/kv/get). ### Parameters @@ -173,7 +173,7 @@ 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). +The corresponding CLI command is [`consul kv put`](/commands/kv/put). ### Parameters @@ -261,7 +261,7 @@ 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). +The corresponding CLI command is [`consul kv delete`](/commands/kv/delete). ### Parameters diff --git a/website/content/api-docs/namespaces.mdx b/website/content/api-docs/namespaces.mdx index 1d3b49871d..6ddf265830 100644 --- a/website/content/api-docs/namespaces.mdx +++ b/website/content/api-docs/namespaces.mdx @@ -29,7 +29,7 @@ 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). +The corresponding CLI command is [`consul namespace create`](/commands/namespace/create). ### Parameters @@ -163,7 +163,7 @@ 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). +The corresponding CLI command is [`consul namespace read`](/commands/namespace/read). ### Parameters @@ -231,7 +231,7 @@ 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). +The corresponding CLI command is [`consul namespace update`](/commands/namespace/update) or [`consul namespace write`](/commands/namespace/write). ### Parameters @@ -370,7 +370,7 @@ 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). +The corresponding CLI command is [`consul namespace delete`](/commands/namespace/delete). ### Parameters @@ -444,7 +444,7 @@ 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). +The corresponding CLI command is [`consul namespace list`](/commands/namespace/list). ### Sample Request diff --git a/website/content/api-docs/operator/area.mdx b/website/content/api-docs/operator/area.mdx index e28fe41f0b..d4333503d5 100644 --- a/website/content/api-docs/operator/area.mdx +++ b/website/content/api-docs/operator/area.mdx @@ -45,7 +45,7 @@ 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). +The corresponding CLI command is [`consul operator area create`](/commands/operator/area#create). ### Parameters @@ -113,7 +113,7 @@ 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). +The corresponding CLI command is [`consul operator area list`](/commands/operator/area#list). ### Parameters @@ -158,7 +158,7 @@ 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). +The corresponding CLI command is [`consul operator area update`](/commands/operator/area#update). ### Parameters @@ -250,7 +250,7 @@ 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). +The corresponding CLI command is [`consul operator area delete`](/commands/operator/area#delete). ### Parameters @@ -288,7 +288,7 @@ 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). +The corresponding CLI command is [`consul operator area join`](/commands/operator/area#join). ### Parameters @@ -363,7 +363,7 @@ 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). +The corresponding CLI command is [`consul operator area members`](/commands/operator/area#members). ### Parameters diff --git a/website/content/api-docs/operator/autopilot.mdx b/website/content/api-docs/operator/autopilot.mdx index 749e795f6c..89ffb67a36 100644 --- a/website/content/api-docs/operator/autopilot.mdx +++ b/website/content/api-docs/operator/autopilot.mdx @@ -33,7 +33,7 @@ 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). +The corresponding CLI command is [`consul operator autopilot get-config`](/commands/operator/autopilot#get-config). ### Parameters @@ -89,7 +89,7 @@ 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). +The corresponding CLI command is [`consul operator autopilot set-config`](/commands/operator/autopilot#set-config). ### Parameters @@ -273,7 +273,7 @@ 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). +The corresponding CLI command is [`consul operator autopilot state`](/commands/operator/autopilot#state). ### Parameters diff --git a/website/content/api-docs/operator/keyring.mdx b/website/content/api-docs/operator/keyring.mdx index b0dfef6081..f493ad336b 100644 --- a/website/content/api-docs/operator/keyring.mdx +++ b/website/content/api-docs/operator/keyring.mdx @@ -35,7 +35,7 @@ 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). +The corresponding CLI command is [`consul keyring -list`](/commands/keyring#list). ### Parameters @@ -122,7 +122,7 @@ 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). +The corresponding CLI command is [`consul keyring -intstall`](/commands/keyring#install). ### Parameters @@ -170,7 +170,7 @@ 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). +The corresponding CLI command is [`consul keyring -use`](/commands/keyring#use). ### Parameters @@ -218,7 +218,7 @@ 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). +The corresponding CLI command is [`consul keyring -remove`](/commands/keyring#remove). ### Parameters diff --git a/website/content/api-docs/operator/license.mdx b/website/content/api-docs/operator/license.mdx index b4853ad1ce..ff0c0b657b 100644 --- a/website/content/api-docs/operator/license.mdx +++ b/website/content/api-docs/operator/license.mdx @@ -31,7 +31,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `all` | `none` | `none` | --> The corresponding CLI command is [`consul license get`](/commands/license#get). +The corresponding CLI command is [`consul license get`](/commands/license#get). ### Parameters @@ -98,7 +98,7 @@ 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). +The corresponding CLI command is [`consul license put`](/commands/license#put). ### Parameters @@ -170,7 +170,7 @@ 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). +The corresponding CLI command is [`consul license reset`](/commands/license#reset). ### Parameters diff --git a/website/content/api-docs/operator/raft.mdx b/website/content/api-docs/operator/raft.mdx index 3bd4dc4b8e..892c5416d0 100644 --- a/website/content/api-docs/operator/raft.mdx +++ b/website/content/api-docs/operator/raft.mdx @@ -130,7 +130,7 @@ 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). +The corresponding CLI command is [`consul operator raft remove-peer`](/commands/operator/raft#remove-peer). ### Parameters diff --git a/website/content/api-docs/snapshot.mdx b/website/content/api-docs/snapshot.mdx index b2866eae3c..36bc57e582 100644 --- a/website/content/api-docs/snapshot.mdx +++ b/website/content/api-docs/snapshot.mdx @@ -39,7 +39,7 @@ 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). +The corresponding CLI command is [`consul snapshot save`](/commands/snapshot/save). ### Parameters @@ -96,7 +96,7 @@ The table below shows this endpoint's support for | ---------------- | ----------------- | ------------- | ------------ | | `NO` | `none` | `none` | `management` | --> The corresponding CLI command is [`consul snapshot restore`](/commands/snapshot/restore). +The corresponding CLI command is [`consul snapshot restore`](/commands/snapshot/restore). ### Parameters diff --git a/website/content/api-docs/status.mdx b/website/content/api-docs/status.mdx index 39df6eeca4..c7cb3e5571 100644 --- a/website/content/api-docs/status.mdx +++ b/website/content/api-docs/status.mdx @@ -70,7 +70,7 @@ 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). +The corresponding CLI command is [`consul operator raft list-peers`](/commands/operator/raft#list-peers). ### Parameters From 451fa0727ffedde0802d6075e701fa209dc29490 Mon Sep 17 00:00:00 2001 From: Jared Kirschner Date: Sat, 15 Jan 2022 09:31:27 -0800 Subject: [PATCH 8/8] docs: add missing link for intention list --- website/content/api-docs/connect/intentions.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/api-docs/connect/intentions.mdx b/website/content/api-docs/connect/intentions.mdx index d6458073a8..ee50d8462c 100644 --- a/website/content/api-docs/connect/intentions.mdx +++ b/website/content/api-docs/connect/intentions.mdx @@ -458,7 +458,7 @@ The table below shows this endpoint's support for for more details.

-The corresponding CLI command is `consul intention list`. +The corresponding CLI command is [`consul intention list`](/commands/intention/list). ### Parameters