List secrets
API 1.25+ The client and daemon API must both be at least 1.25 to use this command. Use the docker version command on the client to check your client and daemon API versions.
Swarm This command works with the Swarm orchestrator.
docker secret ls [OPTIONS]
| Name, shorthand | Default | Description |
--filter , -f | Filter output based on conditions provided | |
--format | Pretty-print secrets using a Go template | |
--quiet , -q | Only display IDs |
| Command | Description |
|---|---|
| docker secret | Manage Docker secrets |
| Command | Description |
| docker secret create | Create a secret from a file or STDIN as content |
| docker secret inspect | Display detailed information on one or more secrets |
| docker secret ls | List secrets |
| docker secret rm | Remove one or more secrets |
Run this command on a manager node to list the secrets in the swarm.
For detailed information about using secrets, refer to manage sensitive data with Docker secrets.
$ docker secret ls
ID NAME CREATED UPDATED
6697bflskwj1998km1gnnjr38 q5s5570vtvnimefos1fyeo2u2 6 weeks ago 6 weeks ago
9u9hk4br2ej0wgngkga6rp4hq my_secret 5 weeks ago 5 weeks ago
mem02h8n73mybpgqjf0kfi1n0 test_secret 3 seconds ago 3 seconds ago
The filtering flag (-f or --filter) format is a key=value pair. If there is more than one filter, then pass multiple flags (e.g., --filter "foo=bar" --filter "bif=baz")
The currently supported filters are:
The id filter matches all or prefix of a secret’s id.
$ docker secret ls -f "id=6697bflskwj1998km1gnnjr38"
ID NAME CREATED UPDATED
6697bflskwj1998km1gnnjr38 q5s5570vtvnimefos1fyeo2u2 6 weeks ago 6 weeks ago
The label filter matches secrets based on the presence of a label alone or a label and a value.
The following filter matches all secrets with a project label regardless of its value:
$ docker secret ls --filter label=project
ID NAME CREATED UPDATED
mem02h8n73mybpgqjf0kfi1n0 test_secret About an hour ago About an hour ago
The following filter matches only services with the project label with the project-a value.
$ docker service ls --filter label=project=test
ID NAME CREATED UPDATED
mem02h8n73mybpgqjf0kfi1n0 test_secret About an hour ago About an hour ago
The name filter matches on all or prefix of a secret’s name.
The following filter matches secret with a name containing a prefix of test.
$ docker secret ls --filter name=test_secret
ID NAME CREATED UPDATED
mem02h8n73mybpgqjf0kfi1n0 test_secret About an hour ago About an hour ago
The formatting option (--format) pretty prints secrets output using a Go template.
Valid placeholders for the Go template are listed below:
| Placeholder | Description |
|---|---|
.ID | Secret ID |
.Name | Secret name |
.CreatedAt | Time when the secret was created |
.UpdatedAt | Time when the secret was updated |
.Labels | All labels assigned to the secret |
.Label | Value of a specific label for this secret. For example {{.Label "secret.ssh.key"}}
|
When using the --format option, the secret ls command will either output the data exactly as the template declares or, when using the table directive, will include column headers as well.
The following example uses a template without headers and outputs the ID and Name entries separated by a colon for all images:
$ docker secret ls --format "{{.ID}}: {{.Name}}"
77af4d6b9913: secret-1
b6fa739cedf5: secret-2
78a85c484f71: secret-3
To list all secrets with their name and created date in a table format you can use:
$ docker secret ls --format "table {{.ID}}\t{{.Name}}\t{{.CreatedAt}}"
ID NAME CREATED
77af4d6b9913 secret-1 5 minutes ago
b6fa739cedf5 secret-2 3 hours ago
78a85c484f71 secret-3 10 days ago
© 2019 Docker, Inc.
Licensed under the Apache License, Version 2.0.
Docker and the Docker logo are trademarks or registered trademarks of Docker, Inc. in the United States and/or other countries.
Docker, Inc. and other parties may also have trademark rights in other terms used herein.
https://docs.docker.com/engine/reference/commandline/secret_ls/