mirror of
https://github.com/docker/docs.git
synced 2026-11-04 10:01:00 +00:00
Vendor the checked-in CLI YAML from Docker Sandboxes release/v0.51 at 7d55286de0c7. This updates command help, adds `sbx policy check http`, and replaces seven agent-specific create pages with redirects to `sbx create`. Validation: full site build with Hugo 0.169.0; upstream byte-for-byte comparison; all 115 command pages, reference links, and seven redirects checked; template formatting and whitespace checks passed.
73 lines
2.4 KiB
YAML
73 lines
2.4 KiB
YAML
name: sbx secret rm
|
|
synopsis: Remove a secret
|
|
usage: sbx secret rm [SERVICE] [flags]
|
|
options:
|
|
- name: all
|
|
default_value: "false"
|
|
usage: Remove every stored secret across all scopes
|
|
- name: all-sandboxes
|
|
default_value: "false"
|
|
usage: |
|
|
Remove registry credentials injected into every sandbox (requires --registry)
|
|
- name: force
|
|
shorthand: f
|
|
default_value: "false"
|
|
usage: Delete without confirmation prompt
|
|
- name: help
|
|
shorthand: h
|
|
default_value: "false"
|
|
usage: help for rm
|
|
- name: registry
|
|
usage: Registry hostname to remove pull credentials for
|
|
- name: sandbox
|
|
usage: |
|
|
Scope the removal to one sandbox (default: all scopes when choosing interactively, global with SERVICE)
|
|
inherited_options:
|
|
- name: cloud
|
|
default_value: "false"
|
|
usage: |
|
|
Dispatch to Docker Cloud Sandboxes API instead of local sandboxd (supported by a growing set of verbs — run 'sbx --cloud --help' for the current list)
|
|
- name: debug
|
|
shorthand: D
|
|
default_value: "false"
|
|
usage: Enable debug logging
|
|
- name: no-input
|
|
default_value: "false"
|
|
usage: |
|
|
Never prompt; commands that need an answer fail with the command to run instead
|
|
example: |4-
|
|
# Choose an existing secret to remove with the arrow keys
|
|
sbx secret rm
|
|
|
|
# Remove a global secret
|
|
sbx secret rm github
|
|
|
|
# Remove a sandbox-scoped secret
|
|
sbx secret rm openai --sandbox my-sandbox
|
|
|
|
# Remove without confirmation prompt
|
|
sbx secret rm github -f
|
|
|
|
# Remove OpenAI or Anthropic credential(s) from global scope (OAuth and/or API key)
|
|
sbx secret rm openai
|
|
sbx secret rm anthropic
|
|
|
|
# Remove custom secret by specifying the placeholder value
|
|
sbx secret rm --placeholder docker-placeholder-value
|
|
|
|
# Remove registry pull credentials (removes host-only and global entries)
|
|
sbx secret rm --registry ghcr.io -f
|
|
|
|
# Remove only the global (all-sandboxes) registry credential
|
|
sbx secret rm --all-sandboxes --registry ghcr.io -f
|
|
|
|
# Remove every stored secret across every scope (service secrets, custom
|
|
# secrets, OAuth tokens, and registry credentials)
|
|
sbx secret rm --all
|
|
|
|
# Remove a cloud custom secret by its name, or by a host it routes
|
|
sbx --cloud secret rm api-example-com
|
|
sbx --cloud secret rm --host api.example.com
|
|
see_also:
|
|
- sbx secret - Manage stored secrets
|