2016-10-27 20:30:32 -04:00
# secret inspect
2023-01-06 13:04:05 -05:00
<!-- - MARKER_GEN_START -->
2016-10-27 20:30:32 -04:00
Display detailed information on one or more secrets
2023-01-06 13:04:05 -05:00
### Options
| Name | Type | Default | Description |
|:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`-f` ](#format ), [`--format` ](#format ) | `string` | | Format output using a custom template:< br > 'json': Print in JSON format< br > 'TEMPLATE': Print output using the given Go template.< br > Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
| `--pretty` | | | Print the information in a human friendly format |
<!-- - MARKER_GEN_END -->
2016-10-27 20:30:32 -04:00
2017-02-07 18:42:48 -05:00
## Description
2016-10-27 20:30:32 -04:00
2018-12-23 06:27:52 -05:00
Inspects the specified secret.
2016-10-27 20:30:32 -04:00
By default, this renders all results in a JSON array. If a format is specified,
the given template will be executed for each result.
2023-08-25 08:10:40 -04:00
Go's [text/template ](https://pkg.go.dev/text/template ) package
2016-10-27 20:30:32 -04:00
describes all the details of the format.
2017-03-17 02:51:48 -04:00
For detailed information about using secrets, refer to [manage sensitive data with Docker secrets ](https://docs.docker.com/engine/swarm/secrets/ ).
2020-04-19 11:08:37 -04:00
> **Note**
>
> This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the
> [Swarm mode section](https://docs.docker.com/engine/swarm/) in the
> documentation.
2018-12-23 06:27:52 -05:00
2016-10-27 20:30:32 -04:00
## Examples
2017-02-07 18:42:48 -05:00
### Inspect a secret by name or ID
2016-10-27 20:30:32 -04:00
You can inspect a secret, either by its *name* , or *ID*
For example, given the following secret:
2021-08-21 08:54:14 -04:00
```console
2016-10-27 20:30:32 -04:00
$ docker secret ls
2017-03-24 04:34:03 -04:00
ID NAME CREATED UPDATED
eo7jnzguqgtpdah3cm5srfb97 my_secret 3 minutes ago 3 minutes ago
2016-10-27 20:30:32 -04:00
```
2021-08-21 08:54:14 -04:00
```console
2016-11-03 17:01:54 -04:00
$ docker secret inspect secret.json
2020-05-11 11:32:52 -04:00
```
The output is in JSON format, for example:
2017-02-07 18:42:48 -05:00
2020-05-11 11:32:52 -04:00
```json
2016-10-27 20:30:32 -04:00
[
2020-05-11 11:32:52 -04:00
{
"ID": "eo7jnzguqgtpdah3cm5srfb97",
"Version": {
"Index": 17
},
"CreatedAt": "2017-03-24T08:15:09.735271783Z",
"UpdatedAt": "2017-03-24T08:15:09.735271783Z",
"Spec": {
"Name": "my_secret",
"Labels": {
"env": "dev",
"rev": "20170324"
}
2016-10-27 20:30:32 -04:00
}
2020-05-11 11:32:52 -04:00
}
2016-10-27 20:30:32 -04:00
]
```
2023-01-06 13:28:29 -05:00
### <a name="format"></a> Format the output (--format)
2016-10-27 20:30:32 -04:00
2016-10-31 11:02:10 -04:00
You can use the --format option to obtain specific information about a
2016-11-22 18:18:50 -05:00
secret. The following example command outputs the creation time of the
2016-10-27 20:30:32 -04:00
secret.
2021-08-21 08:54:14 -04:00
```console
2017-03-24 04:34:03 -04:00
$ docker secret inspect --format='{{.CreatedAt}}' eo7jnzguqgtpdah3cm5srfb97
2017-02-07 18:42:48 -05:00
2017-03-24 04:34:03 -04:00
2017-03-24 08:15:09.735271783 +0000 UTC
2017-02-07 18:42:48 -05:00
```
2016-10-27 20:30:32 -04:00
2017-02-07 18:42:48 -05:00
## Related commands
2016-10-27 20:30:32 -04:00
* [secret create ](secret_create.md )
* [secret ls ](secret_ls.md )
* [secret rm ](secret_rm.md )