Remove docs refs to NS inference from ACL token

This commit is contained in:
freddygv 2019-12-10 13:50:28 -07:00
parent 9812b32155
commit 775ea7af6e
12 changed files with 85 additions and 111 deletions

View File

@ -78,9 +78,8 @@ func (f *HTTPFlags) NamespaceFlags() *flag.FlagSet {
fs := flag.NewFlagSet("", flag.ContinueOnError) fs := flag.NewFlagSet("", flag.ContinueOnError)
// TODO (namespaces) Do we want to allow setting via an env var? CONSUL_NAMESPACE // TODO (namespaces) Do we want to allow setting via an env var? CONSUL_NAMESPACE
fs.Var(&f.namespace, "ns", fs.Var(&f.namespace, "ns",
"Specifies the namespace to query. If not provided, the namespace will be inferred +"+ "Specifies the namespace to query. If not provided, the namespace will"+
"from the request's ACL token, or will default to the `default` namespace. "+ "default to the `default` namespace. Namespaces is a Consul Enterprise feature.")
"Namespaces is a Consul Enterprise feature.")
return fs return fs
} }

View File

@ -308,8 +308,8 @@ replication enabled.
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace of - `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace of
the Auth Method to use for Login. If not provided in the JSON body, the value of the Auth Method to use for Login. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used. the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inferred from the request's ACL If not provided at all, the namespace will default to the `default` namespace.
token, or will default to the `default` namespace. Added in Consul 1.7.0. Added in Consul 1.7.0.
### Sample Payload ### Sample Payload

View File

@ -57,8 +57,8 @@ The table below shows this endpoint's support for
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace to - `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace to
create the auth method within. If not provided in the JSON body, the value of create the auth method within. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used. the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL If not provided at all, the namespace will default to the `default` namespace.
token or will default to the `default` namespace. Added in Consul 1.7.0. Added in Consul 1.7.0.
### Sample Payload ### Sample Payload
@ -128,12 +128,12 @@ The table below shows this endpoint's support for
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to lookup - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to lookup
the auth method within. This value can be specified as the `ns` URL query the auth method within. This value can be specified as the `ns` URL query
parameter or in the `X-Consul-Namespace` header. If not provided by either, parameter or in the `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default the namespace will default to the `default` namespace. Added in Consul 1.7.
to the `default` namespace. Added in Consul 1.7.0.
### Sample Request ### Sample Request
```sh ```sh
$ curl -X GET http://127.0.0.1:8500/v1/acl/auth-method/minikube $ curl -X GET http://127.0.0.1:8500/v1/acl/auth-method/minikube
``` ```
@ -194,8 +194,8 @@ The table below shows this endpoint's support for
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace of - `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace of
the auth method to update. If not provided in the JSON body, the value of the auth method to update. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used. the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL If not provided at all, the namespace will default to the `default` namespace.
token or will default to the `default` namespace. Added in Consul 1.7.0. Added in Consul 1.7.0.
### Sample Payload ### Sample Payload
@ -269,12 +269,12 @@ The table below shows this endpoint's support for
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace of the - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace of the
Auth Method to delete. This value can be specified as the `ns` URL query Auth Method to delete. This value can be specified as the `ns` URL query
parameter or in the `X-Consul-Namespace` header. If not provided by either, parameter or in the `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default the namespace will default to the `default` namespace. Added in Consul 1.7.
to the `default` namespace. Added in Consul 1.7.0.
### Sample Request ### Sample Request
```sh ```sh
$ curl -X DELETE \ $ curl -X DELETE \
http://127.0.0.1:8500/v1/acl/auth-method/minikube http://127.0.0.1:8500/v1/acl/auth-method/minikube
``` ```
@ -308,10 +308,9 @@ The table below shows this endpoint's support for
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list
the auth methods for. This value can be specified as the `ns` URL query the auth methods for. This value can be specified as the `ns` URL query
parameter or in the `X-Consul-Namespace` header. If not provided by either, parameter or in the `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default the namespace will default to the `default` namespace. The namespace may be
to the `default` namespace. The namespace may be specified as '*' and then specified as '*' and then results will be returned for all namespaces.
results will be returned for all namespaces. Added in Consul 1.7.0. Added in Consul 1.7.0.
## Sample Request ## Sample Request

View File

@ -91,8 +91,8 @@ The table below shows this endpoint's support for
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace to - `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace to
create the binding rule. If not provided in the JSON body, the value of create the binding rule. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used. the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL If not provided at all, the namespace will default to the `default` namespace.
token or will default to the `default` namespace. Added in Consul 1.7.0. Added in Consul 1.7.0.
### Sample Payload ### Sample Payload
@ -157,9 +157,7 @@ The table below shows this endpoint's support for
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to lookup - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to lookup
the binding rule. This value can be specified as the `ns` URL query the binding rule. This value can be specified as the `ns` URL query
parameter orthe `X-Consul-Namespace` header. If not provided by either, parameter orthe `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default the namespace will default to the `default` namespace. Added in Consul 1.7.0.
to the `default` namespace. Added in Consul 1.7.0.
### Sample Request ### Sample Request
@ -261,8 +259,8 @@ The table below shows this endpoint's support for
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace of - `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace of
the binding rule to update. If not provided in the JSON body, the value of the binding rule to update. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used. the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL If not provided at all, the namespace will default to the `default` namespace.
token or will default to the `default` namespace. Added in Consul 1.7.0. Added in Consul 1.7.0.
### Sample Payload ### Sample Payload
@ -327,8 +325,7 @@ The table below shows this endpoint's support for
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace of the - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace of the
binding rule to delete. This value can be specified as the `ns` URL query binding rule to delete. This value can be specified as the `ns` URL query
parameter orthe `X-Consul-Namespace` header. If not provided by either, parameter orthe `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default the namespace will default to the `default` namespace. Added in Consul 1.7.0.
to the `default` namespace. Added in Consul 1.7.0.
### Sample Request ### Sample Request
@ -368,9 +365,9 @@ The table below shows this endpoint's support for
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list
the binding rules for. This value can be specified as the `ns` URL query the binding rules for. This value can be specified as the `ns` URL query
parameter orthe `X-Consul-Namespace` header. If not provided by either, parameter orthe `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default the namespace will default to the `default` namespace.
to the `default` namespace. The namespace may be specified as '*' and then The namespace may be specified as '*' and then results will be returned for all namespaces.
results will be returned for all namespaces. Added in Consul 1.7.0. Added in Consul 1.7.0.
## Sample Request ## Sample Request

View File

@ -53,8 +53,8 @@ The table below shows this endpoint's support for
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace to - `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace to
create the policy. If not provided in the JSON body, the value of create the policy. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used. the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL If not provided at all, the namespace will default to the `default` namespace.
token or will default to the `default` namespace. Added in Consul 1.7.0. Added in Consul 1.7.0.
### Sample Payload ### Sample Payload
@ -119,8 +119,7 @@ The table below shows this endpoint's support for
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to lookup - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to lookup
the policy. This value can be specified as the `ns` URL query the policy. This value can be specified as the `ns` URL query
parameter orthe `X-Consul-Namespace` header. If not provided by either, parameter orthe `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default the namespace will default to the `default` namespace. Added in Consul 1.7.0.
to the `default` namespace. Added in Consul 1.7.0.
### Sample Request ### Sample Request
@ -185,8 +184,8 @@ The table below shows this endpoint's support for
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace of - `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace of
the policy to update. If not provided in the JSON body, the value of the policy to update. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used. the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL If not provided at all, the namespace will default to the `default` namespace.
token or will default to the `default` namespace. Added in Consul 1.7.0. Added in Consul 1.7.0.
### Sample Payload ### Sample Payload
@ -250,8 +249,7 @@ The table below shows this endpoint's support for
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace of the - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace of the
policy to delete. This value can be specified as the `ns` URL query policy to delete. This value can be specified as the `ns` URL query
parameter orthe `X-Consul-Namespace` header. If not provided by either, parameter orthe `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default the namespace will default to the `default` namespace. Added in Consul 1.7.0.
to the `default` namespace. Added in Consul 1.7.0.
### Sample Request ### Sample Request
@ -288,8 +286,7 @@ The table below shows this endpoint's support for
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list
the Policies for. This value can be specified as the `ns` URL query the Policies for. This value can be specified as the `ns` URL query
parameter orthe `X-Consul-Namespace` header. If not provided by either, parameter orthe `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default the namespace will default to the `default` namespace. The namespace may be specified as '*' and then
to the `default` namespace. The namespace may be specified as '*' and then
results will be returned for all namespaces. Added in Consul 1.7.0. results will be returned for all namespaces. Added in Consul 1.7.0.
## Sample Request ## Sample Request

View File

@ -67,8 +67,8 @@ The table below shows this endpoint's support for
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace to - `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace to
create the role. If not provided in the JSON body, the value of create the role. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used. the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL If not provided at all, the namespace will default to the `default` namespace.
token or will default to the `default` namespace. Added in Consul 1.7.0. Added in Consul 1.7.0.
### Sample Payload ### Sample Payload
@ -163,8 +163,7 @@ The table below shows this endpoint's support for
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to lookup - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to lookup
the role. This value can be specified as the `ns` URL query the role. This value can be specified as the `ns` URL query
parameter orthe `X-Consul-Namespace` header. If not provided by either, parameter orthe `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default the namespace will default to the `default` namespace. Added in Consul 1.7.0.
to the `default` namespace. Added in Consul 1.7.0.
### Sample Request ### Sample Request
@ -229,8 +228,7 @@ The table below shows this endpoint's support for
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to lookup - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to lookup
the role. This value can be specified as the `ns` URL query the role. This value can be specified as the `ns` URL query
parameter orthe `X-Consul-Namespace` header. If not provided by either, parameter orthe `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default the namespace will default to the `default` namespace. Added in Consul 1.7.0.
to the `default` namespace. Added in Consul 1.7.0.
### Sample Request ### Sample Request
@ -313,8 +311,8 @@ The table below shows this endpoint's support for
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace of - `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace of
the role to update. If not provided in the JSON body, the value of the role to update. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used. the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL If not provided at all, the namespace will default to the `default` namespace.
token or will default to the `default` namespace. Added in Consul 1.7.0. Added in Consul 1.7.0.
### Sample Payload ### Sample Payload
@ -395,8 +393,7 @@ The table below shows this endpoint's support for
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace of the - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace of the
role to delete. This value can be specified as the `ns` URL query role to delete. This value can be specified as the `ns` URL query
parameter orthe `X-Consul-Namespace` header. If not provided by either, parameter orthe `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default the namespace will default to the `default` namespace. Added in Consul 1.7.0.
to the `default` namespace. Added in Consul 1.7.0.
### Sample Request ### Sample Request
@ -438,8 +435,7 @@ The table below shows this endpoint's support for
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list
the roles for. This value can be specified as the `ns` URL query the roles for. This value can be specified as the `ns` URL query
parameter orthe `X-Consul-Namespace` header. If not provided by either, parameter orthe `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default the namespace will default to the `default` namespace. The namespace may be specified as '*' and then
to the `default` namespace. The namespace may be specified as '*' and then
results will be returned for all namespaces. Added in Consul 1.7.0. results will be returned for all namespaces. Added in Consul 1.7.0.
## Sample Request ## Sample Request

View File

@ -93,8 +93,8 @@ The table below shows this endpoint's support for
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace to - `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace to
create the token. If not provided in the JSON body, the value of create the token. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used. the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL If not provided at all, the namespace will default to the `default` namespace.
token or will default to the `default` namespace. Added in Consul 1.7.0. Added in Consul 1.7.0.
### Sample Payload ### Sample Payload
@ -173,8 +173,7 @@ The table below shows this endpoint's support for
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to lookup - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to lookup
the token. This value can be specified as the `ns` URL query the token. This value can be specified as the `ns` URL query
parameter orthe `X-Consul-Namespace` header. If not provided by either, parameter orthe `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default the namespace will default to the `default` namespace. Added in Consul 1.7.0.
to the `default` namespace. Added in Consul 1.7.0.
### Sample Request ### Sample Request
@ -344,8 +343,8 @@ The table below shows this endpoint's support for
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace of - `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace of
the token to update. If not provided in the JSON body, the value of the token to update. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used. the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL If not provided at all, the namespace will default to the `default` namespace.
token or will default to the `default` namespace. Added in Consul 1.7.0. Added in Consul 1.7.0.
### Sample Payload ### Sample Payload
@ -432,8 +431,8 @@ The table below shows this endpoint's support for
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace of - `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace of
the token to be cloned. If not provided in the JSON body, the value of the token to be cloned. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used. the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL If not provided at all, the namespace will default to the `default` namespace.
token or will default to the `default` namespace. Added in Consul 1.7.0. Added in Consul 1.7.0.
### Sample Payload ### Sample Payload
@ -509,8 +508,7 @@ The table below shows this endpoint's support for
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace of the - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace of the
token to delete. This value can be specified as the `ns` URL query token to delete. This value can be specified as the `ns` URL query
parameter orthe `X-Consul-Namespace` header. If not provided by either, parameter orthe `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default the namespace will default to the `default` namespace. Added in Consul 1.7.0.
to the `default` namespace. Added in Consul 1.7.0.
### Sample Request ### Sample Request
@ -556,8 +554,7 @@ The table below shows this endpoint's support for
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list
the tokens for. This value can be specified as the `ns` URL query the tokens for. This value can be specified as the `ns` URL query
parameter orthe `X-Consul-Namespace` header. If not provided by either, parameter orthe `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default the namespace will default to the `default` namespace. The namespace may be specified as '*' and then
to the `default` namespace. The namespace may be specified as '*' and then
results will be returned for all namespaces. Added in Consul 1.7.0. results will be returned for all namespaces. Added in Consul 1.7.0.
## Sample Request ## Sample Request

View File

@ -91,8 +91,7 @@ The table below shows this endpoint's support for
`ns` URL query parameter or in the `X-Consul-Namespace` header. Additionally, `ns` URL query parameter or in the `X-Consul-Namespace` header. Additionally,
the namespace may be provided within the `Service` or `Check` fields but if the namespace may be provided within the `Service` or `Check` fields but if
present in multiple places, they must all be the same. If not provided at all, present in multiple places, they must all be the same. If not provided at all,
the namespace will be inherited from the request's ACL token or will default the namespace will default to the `default` namespace. Added in Consul 1.7.0.
to the `default` namespace. Added in Consul 1.7.0.
It is important to note that `Check` does not have to be provided with `Service` It is important to note that `Check` does not have to be provided with `Service`
@ -206,8 +205,8 @@ The behavior of the endpoint depends on what keys are provided.
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace in which the - `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace in which the
service and checks will be deregistered. If not provided in the JSON body, the value of service and checks will be deregistered. If not provided in the JSON body, the value of
the `ns` URL query parameter or the `X-Consul-Namespace` header will be used. the `ns` URL query parameter or the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL If not provided at all, the namespace will default to the `default` namespace.
token or will default to the `default` namespace. Added in Consul 1.7.0. Added in Consul 1.7.0.
### Sample Payloads ### Sample Payloads
@ -407,8 +406,8 @@ The table below shows this endpoint's support for
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list services. - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list services.
This value may be provided by either the `ns` URL query parameter or in the This value may be provided by either the `ns` URL query parameter or in the
`X-Consul-Namespace` header. If not provided at all, the namespace will be inherited `X-Consul-Namespace` header. If not provided at all, the namespace will default to
from the request's ACL token or will default to the `default` namespace. Added in Consul 1.7.0. the `default` namespace. Added in Consul 1.7.0.
### Sample Request ### Sample Request
@ -479,8 +478,8 @@ The table below shows this endpoint's support for
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to use for the - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to use for the
query. This value may be provided by either the `ns` URL query parameter or in the query. This value may be provided by either the `ns` URL query parameter or in the
`X-Consul-Namespace` header. If not provided at all, the namespace will be inherited `X-Consul-Namespace` header. If not provided at all, the namespace will default to
from the request's ACL token or will default to the `default` namespace. Added in Consul 1.7.0. the `default` namespace. Added in Consul 1.7.0.
### Sample Request ### Sample Request
@ -685,8 +684,8 @@ The table below shows this endpoint's support for
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list services. - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list services.
This value may be provided by either the `ns` URL query parameter or in the This value may be provided by either the `ns` URL query parameter or in the
`X-Consul-Namespace` header. If not provided at all, the namespace will be inherited `X-Consul-Namespace` header. If not provided at all, the namespace will default to
from the request's ACL token or will default to the `default` namespace. Added in Consul 1.7.0. the `default` namespace. Added in Consul 1.7.0.
### Sample Request ### Sample Request

View File

@ -47,8 +47,8 @@ The table below shows this endpoint's support for
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list checks. - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list checks.
This value may be provided by either the `ns` URL query parameter or in the This value may be provided by either the `ns` URL query parameter or in the
`X-Consul-Namespace` header. If not provided at all, the namespace will be inherited `X-Consul-Namespace` header. If not provided at all, the namespace will default
from the request's ACL token or will default to the `default` namespace. To view to the `default` namespace. To view
checks for multiple namespaces the `*` wildcard namespace may be used. Added in Consul 1.7.0. checks for multiple namespaces the `*` wildcard namespace may be used. Added in Consul 1.7.0.
### Sample Request ### Sample Request
@ -152,8 +152,8 @@ The table below shows this endpoint's support for
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace of the service. - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace of the service.
This value may be provided by either the `ns` URL query parameter or in the This value may be provided by either the `ns` URL query parameter or in the
`X-Consul-Namespace` header. If not provided at all, the namespace will be inherited `X-Consul-Namespace` header. If not provided at all, the namespace will default
from the request's ACL token or will default to the `default` namespace. Added in Consul 1.7.0. to the `default` namespace. Added in Consul 1.7.0.
### Sample Request ### Sample Request
@ -252,8 +252,8 @@ The table below shows this endpoint's support for
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace of the service. - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace of the service.
This value may be provided by either the `ns` URL query parameter or in the This value may be provided by either the `ns` URL query parameter or in the
`X-Consul-Namespace` header. If not provided at all, the namespace will be inherited `X-Consul-Namespace` header. If not provided at all, the namespace will default to
from the request's ACL token or will default to the `default` namespace. Added in Consul 1.7.0. the `default` namespace. Added in Consul 1.7.0.
### Sample Request ### Sample Request
@ -447,8 +447,8 @@ The table below shows this endpoint's support for
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query. - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query.
This value may be provided by either the `ns` URL query parameter or in the This value may be provided by either the `ns` URL query parameter or in the
`X-Consul-Namespace` header. If not provided at all, the namespace will be inherited `X-Consul-Namespace` header. If not provided at all, the namespace will default
from the request's ACL token or will default to the `default` namespace. Added in Consul 1.7.0. to the `default` namespace. Added in Consul 1.7.0.
### Sample Request ### Sample Request

View File

@ -68,9 +68,8 @@ The table below shows this endpoint's support for
This is specified as part of the URL as a query parameter. This is specified as part of the URL as a query parameter.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query. - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query.
If not provided, the namespace will be inferred from the request's ACL token, If not provided, the namespace will default to the `default` namespace.
or will default to the `default` namespace. This is specified as part of the This is specified as part of the URL as a query parameter. Added in Consul 1.7.0.
URL as a query parameter. Added in Consul 1.7.0.
### Sample Request ### Sample Request
@ -207,9 +206,8 @@ The table below shows this endpoint's support for
of the key. The key must be held by this session to be unlocked. of the key. The key must be held by this session to be unlocked.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query. - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query.
If not provided, the namespace will be inferred from the request's ACL token, If not provided, the namespace will default to the `default` namespace.
or will default to the `default` namespace. This is specified as part of the This is specified as part of the URL as a query parameter. Added in Consul 1.7.0.
URL as a query parameter. Added in Consul 1.7.0.
### Sample Payload ### Sample Payload
@ -268,9 +266,8 @@ The table below shows this endpoint's support for
deleted if the index matches the `ModifyIndex` of that key. deleted if the index matches the `ModifyIndex` of that key.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query. - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query.
If not provided, the namespace will be inferred from the request's ACL token, If not provided, the namespace will default to the `default` namespace.
or will default to the `default` namespace. This is specified as part of the This is specified as part of the URL as a query parameter. Added in Consul 1.7.0.
URL as a query parameter. Added in Consul 1.7.0.
### Sample Request ### Sample Request

View File

@ -32,9 +32,8 @@ The table below shows this endpoint's support for
### Parameters ### Parameters
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query. - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query.
If not provided, the namespace will be inferred from the request's ACL token, If not provided, the namespace will default to the `default` namespace.
or will default to the `default` namespace. This is specified as part of the This is specified as part of the URL as a query parameter. Added in Consul 1.7.0.
URL as a query parameter. Added in Consul 1.7.0.
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to - `dc` `(string: "")` - Specifies the datacenter to query. This will default to
the datacenter of the agent being queried. This is specified as part of the the datacenter of the agent being queried. This is specified as part of the
@ -132,9 +131,8 @@ The table below shows this endpoint's support for
URL as a query parameter. Using this across datacenters is not recommended. URL as a query parameter. Using this across datacenters is not recommended.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query. - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query.
If not provided, the namespace will be inferred from the request's ACL token, If not provided, the namespace will default to the `default` namespace.
or will default to the `default` namespace. This is specified as part of the This is specified as part of the URL as a query parameter. Added in Consul 1.7.0.
URL as a query parameter. Added in Consul 1.7.0.
### Sample Request ### Sample Request
@ -178,9 +176,8 @@ The table below shows this endpoint's support for
URL as a query parameter. Using this across datacenters is not recommended. URL as a query parameter. Using this across datacenters is not recommended.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query. - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query.
If not provided, the namespace will be inferred from the request's ACL token, If not provided, the namespace will default to the `default` namespace.
or will default to the `default` namespace. This is specified as part of the This is specified as part of the URL as a query parameter. Added in Consul 1.7.0.
URL as a query parameter. Added in Consul 1.7.0.
### Sample Request ### Sample Request
@ -239,9 +236,8 @@ The table below shows this endpoint's support for
URL as a query parameter. Using this across datacenters is not recommended. URL as a query parameter. Using this across datacenters is not recommended.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query. - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query.
If not provided, the namespace will be inferred from the request's ACL token, If not provided, the namespace will default to the `default` namespace.
or will default to the `default` namespace. This is specified as part of the This is specified as part of the URL as a query parameter. Added in Consul 1.7.0.
URL as a query parameter. Added in Consul 1.7.0.
### Sample Request ### Sample Request
@ -295,9 +291,8 @@ The table below shows this endpoint's support for
URL as a query parameter. Using this across datacenters is not recommended. URL as a query parameter. Using this across datacenters is not recommended.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query. - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query.
If not provided, the namespace will be inferred from the request's ACL token, If not provided, the namespace will default to the `default` namespace.
or will default to the `default` namespace. This is specified as part of the This is specified as part of the URL as a query parameter. Added in Consul 1.7.0.
URL as a query parameter. Added in Consul 1.7.0.
### Sample Request ### Sample Request
@ -355,9 +350,8 @@ The table below shows this endpoint's support for
URL as a query parameter. Using this across datacenters is not recommended. URL as a query parameter. Using this across datacenters is not recommended.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query. - `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query.
If not provided, the namespace will be inferred from the request's ACL token, If not provided, the namespace will default to the `default` namespace.
or will default to the `default` namespace. This is specified as part of the This is specified as part of the URL as a query parameter. Added in Consul 1.7.0.
URL as a query parameter. Added in Consul 1.7.0.
### Sample Request ### Sample Request

View File

@ -1,3 +1,2 @@
* `-ns=<string>` - Specifies the namespace to query. If not provided, the namespace * `-ns=<string>` - Specifies the namespace to query. If not provided, the namespace
will be inferred from the request's ACL token, or will default to will default to the `default` namespace. Namespaces is a Consul Enterprise feature added in v1.7.0.
the `default` namespace. Namespaces is a Consul Enterprise feature added in v1.7.0.