open-consul/website/pages/partials/http_api_options_client.mdx

37 lines
1.9 KiB
Plaintext
Raw Normal View History

2020-04-06 20:27:35 +00:00
- `-ca-file=<value>` - Path to a CA file to use for TLS when communicating with Consul.
2017-04-14 20:37:29 +00:00
This can also be specified via the `CONSUL_CACERT` environment variable.
2020-04-06 20:27:35 +00:00
- `-ca-path=<value>` - Path to a directory of CA certificates to use for TLS when
2017-04-14 20:37:29 +00:00
communicating with Consul. This can also be specified via the `CONSUL_CAPATH`
environment variable.
2020-04-06 20:27:35 +00:00
- `-client-cert=<value>` - Path to a client cert file to use for TLS when
2017-04-14 20:37:29 +00:00
`verify_incoming` is enabled. This can also be specified via the `CONSUL_CLIENT_CERT`
environment variable.
2020-04-06 20:27:35 +00:00
- `-client-key=<value>` - Path to a client key file to use for TLS when
2017-04-14 20:37:29 +00:00
`verify_incoming` is enabled. This can also be specified via the `CONSUL_CLIENT_KEY`
environment variable.
2020-04-06 20:27:35 +00:00
- `-http-addr=<addr>` - Address of the Consul agent with the port. This can be
an IP address or DNS address, but it must include the port. This can also be
specified via the `CONSUL_HTTP_ADDR` environment variable. In Consul 0.8 and
later, the default value is http://127.0.0.1:8500, and https can optionally be
used instead. The scheme can also be set to HTTPS by setting the environment
variable `CONSUL_HTTP_SSL=true`. This may be a unix domain socket using
`unix:///path/to/socket` if the [agent is configured to
2020-04-09 23:46:54 +00:00
listen](/docs/agent/options#addresses) that way.
2020-04-06 20:27:35 +00:00
- `-tls-server-name=<value>` - The server name to use as the SNI host when
2017-04-14 20:37:29 +00:00
connecting via TLS. This can also be specified via the `CONSUL_TLS_SERVER_NAME`
environment variable.
2020-04-06 20:27:35 +00:00
- `-token=<value>` - ACL token to use in the request. This can also be specified
via the `CONSUL_HTTP_TOKEN` environment variable. If unspecified, the query
will default to the token of the Consul agent at the HTTP address.
2020-04-06 20:27:35 +00:00
- `-token-file=<value>` - File containing the ACL token to use in the request
instead of one specified via the `-token` argument or `CONSUL_HTTP_TOKEN`
environment variable. This can also be specified via the
`CONSUL_HTTP_TOKEN_FILE` environment variable.