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

Updating HTTP API endpoints with CLI equivalent links

This commit is contained in:
Chip Vaughn 2022-01-10 14:21:32 -05:00
parent e3f5dc0987
commit 309f1eab4b
23 changed files with 185 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -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: <required>)` - 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: <required>)` - 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: <required>)` - 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: <required>)` - 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: "")` <EnterpriseAlert inline /> - Specifies the namespace to list

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

@ -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: <required>)` - 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: <required>)` - 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: <required>)` - 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

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

@ -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: <required>)` - 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

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

@ -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: <required>)` - 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: <required>)` - 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=<string>`](https://www.consul.io/commands/acl/policy/read#name)
### Parameters
- `name` `(string: <required>)` - 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: <required>)` - 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: <required>)` - 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: "")` <EnterpriseAlert inline /> - Specifies the namespace to list

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

@ -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: <required>)` - 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: <required>)` - 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=<string>`](https://www.consul.io/commands/acl/role/read#name)
### Parameters
- `name` `(string: <required>)` - 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: <required>)` - 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: <required>)` - 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

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

@ -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: <required>)` - 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: <required>)` - 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: <required>)` - 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

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

@ -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: <required>)` - 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: <required>)` - 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: <required>)` - 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.

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

@ -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: <required>)` - Specifies the ID of the service to

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

@ -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

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

@ -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

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

@ -125,6 +125,8 @@ The table below shows this endpoint's support for
<sup>1</sup> ACL required was <code>operator:read</code> prior to versions 1.8.6,
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: <required>)` - Specifies the CA provider type to use.

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

@ -54,6 +54,8 @@ The table below shows this endpoint's support for
for more details.
</p>
-> The corresponding CLI command is [`consul intention create -replace`](https://www.consul.io/commands/intention/create#replace)
### URL Parameters
- `source` `(string: <required>)` - Specifies the source service. This
@ -163,6 +165,8 @@ The table below shows this endpoint's support for
for more details.
</p>
-> The corresponding CLI command is [`consul intention create`](https://www.consul.io/commands/intention/create)
### URL Parameters
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the default
@ -315,6 +319,8 @@ The table below shows this endpoint's support for
for more details.
</p>
-> The corresponding CLI command is [`consul intention create`](https://www.consul.io/commands/intention/get)
### Parameters
- `source` `(string: <required>)` - Specifies the source service. This
@ -390,6 +396,8 @@ The table below shows this endpoint's support for
for more details.
</p>
-> The corresponding CLI command is [`consul intention create`](https://www.consul.io/commands/intention/get)
### Parameters
- `uuid` `(string: <required>)` - 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.
</p>
-> 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.
</p>
-> The corresponding CLI command is [`consul intention delete`](https://www.consul.io/commands/intention/delete)
### Parameters
- `source` `(string: <required>)` - Specifies the source service. This
@ -597,6 +609,8 @@ The table below shows this endpoint's support for
for more details.
</p>
-> The corresponding CLI command is [`consul intention delete`](https://www.consul.io/commands/intention/delete)
### Parameters
- `uuid` `(string: <required>)` - 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.
</p>
-> The corresponding CLI command is [`consul intention check`](https://www.consul.io/commands/intention/check)
### Parameters
- `source` `(string: <required>)` - Specifies the source service. This
@ -715,6 +731,8 @@ The table below shows this endpoint's support for
for more details.
</p>
-> The corresponding CLI command is [`consul intention match`](https://www.consul.io/commands/intention/match)
### Parameters
- `by` `(string: <required>)` - Specifies whether to match the "name" value

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

@ -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

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

@ -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: <required>)` - Specifies the name of the event to fire. This

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

@ -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

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

@ -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: <required>)` - The namespaces name. This must be a valid
@ -161,6 +163,8 @@ The table below shows this endpoint's support for
<sup>1</sup> Access can be granted to list the Namespace if the token used when making
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: <required>)` - 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: <optional>)` - 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: <required>)` - Specifies the namespace to delete. This
@ -436,6 +444,8 @@ The table below shows this endpoint's support for
<sup>1</sup> Access can be granted to list the Namespace if the token used when making
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

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

@ -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: <required>)` - 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: <required>)` - 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: <required>)` - Specifies the UUID of the area to list. This

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

@ -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

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

@ -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

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

@ -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.

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

@ -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

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

@ -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

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

@ -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