2019-05-01 21:11:23 +00:00
|
|
|
---
|
2020-09-01 15:14:13 +00:00
|
|
|
layout: commands
|
2020-04-07 18:55:19 +00:00
|
|
|
page_title: 'Commands: Logout'
|
2019-05-01 21:11:23 +00:00
|
|
|
description: >
|
2020-04-07 18:55:19 +00:00
|
|
|
The `logout` command will destroy the provided token if it was created from
|
|
|
|
|
`consul login`.
|
2019-05-01 21:11:23 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Consul Logout
|
|
|
|
|
|
|
|
|
|
Command: `consul logout`
|
|
|
|
|
|
2023-01-25 16:52:43 +00:00
|
|
|
Corresponding HTTP API Endpoint: [\[POST\] /v1/acl/logout](/consul/api-docs/acl#logout-from-auth-method)
|
2022-01-10 17:40:11 +00:00
|
|
|
|
2019-05-01 21:11:23 +00:00
|
|
|
The `logout` command will destroy the provided token if it was created from
|
|
|
|
|
`consul login`.
|
|
|
|
|
|
2023-01-25 16:52:43 +00:00
|
|
|
The table below shows this command's [required ACLs](/consul/api-docs/api-structure#authentication). Configuration of
|
|
|
|
|
[blocking queries](/consul/api-docs/features/blocking) and [agent caching](/consul/api-docs/features/caching)
|
2022-01-10 21:44:56 +00:00
|
|
|
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
|
|
|
|
|
|
|
|
|
| ACL Required |
|
|
|
|
|
| ------------ |
|
|
|
|
|
| `none` |
|
|
|
|
|
|
2019-05-01 21:11:23 +00:00
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
Usage: `consul logout [options]`
|
|
|
|
|
|
|
|
|
|
-> The token to delete should be specified with the `-token` argument, the
|
|
|
|
|
`CONSUL_HTTP_TOKEN` environment variable, the `-token-file` argument, or the
|
|
|
|
|
`CONSUL_HTTP_TOKEN_FILE` environment variable.
|
|
|
|
|
|
|
|
|
|
#### API Options
|
|
|
|
|
|
2020-04-07 18:55:19 +00:00
|
|
|
@include 'http_api_options_client.mdx'
|
2019-05-01 21:11:23 +00:00
|
|
|
|
|
|
|
|
### Examples
|
|
|
|
|
|
|
|
|
|
Logout and delete a login token.
|
|
|
|
|
|
2020-05-19 18:32:38 +00:00
|
|
|
```shell-session
|
2019-05-01 21:11:23 +00:00
|
|
|
$ consul logout -token-file 'consul.token'
|
|
|
|
|
```
|
