Skip to content

plexctl secret

Synopsis

plexctl secret is the operator surface for the metadata-only Secret Store inventory of a Project. The projection reports each secret's name and the currently-served KV v2 version and never the secret value, the backing path, or any wrapping material. There is deliberately no get / reveal subcommand — the server-side projection carries nothing the CLI could surface.

text
plexctl secret list --project <uuid> [flags]

Subcommands

plexctl secret list

GETs /v1/projects/{project_id}/secrets and renders one row per inventory entry, projected onto exactly two columns — NAME and CURRENT_VERSION. Pagination is cursor-based via --cursor / --limit; the response carries a next_cursor the caller threads into the next --cursor to walk the pages. The --project flag is required and parsed as a UUID locally; a malformed value exits 2.

Flags

plexctl secret list

FlagTypeRequiredDescription
--projectstring (UUID)yesOwning Project UUID whose Secret Store inventory to list.
--cursorstringnoContinuation token returned by a previous call's next_cursor.
--limitintnoMaximum items per page (server default when zero).

Persistent flags inherited from root

--server, --profile, --token-file, --output. See ../plexctl.md for the canonical list.

Exit codes

See ../plexctl.md#exit-code-taxonomy for the inherited base table. The cases that apply to this family:

CodeTrigger
0The inventory row(s) were rendered to stdout.
1Transport or API failure, a 5xx, or a malformed response body.
2Malformed --project UUID or a missing required flag.
3Missing or insecure credentials, or a 401 Unauthorized.
4403 Forbidden.
77ReBAC denial (403 Forbidden with code == "rebac_denied").

Examples

List the Secret Store inventory of a Project

shell
export PLEXSPHERE_URL="${PLEXSPHERE_URL:-https://localhost:8080}"

plexctl secret list \
  --server  "${PLEXSPHERE_URL}" \
  --project 0190a8b8-a0c0-7a0a-8a0a-a0a0a0a0a0c0

Walk the inventory pages as JSON

shell
plexctl secret list \
  --server  "${PLEXSPHERE_URL}" \
  --project 0190a8b8-a0c0-7a0a-8a0a-a0a0a0a0a0c0 \
  --limit   50 \
  --output  json

plexctl secret list \
  --server  "${PLEXSPHERE_URL}" \
  --project 0190a8b8-a0c0-7a0a-8a0a-a0a0a0a0a0c0 \
  --limit   50 \
  --cursor  "${NEXT_CURSOR}" \
  --output  json

Cross-references