{
  "schema_version": 2,
  "id": "integrate/redis-data-integration/reference/cli/redis-di-describe-secret",
  "title": "redis-di describe-secret",
  "url": "https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di-describe-secret/",
  "summary": "Describes a secret of a pipeline",
  "tags": [
    "redis-di"
  ],
  "last_updated": "2026-09-18T16:41:35+01:00",
  "page_type": "content",
  "content_hash": "95041c5f1f5593154bec622e48667706a10b00fe78eb988d06acfeccb0db96ca",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "Describes a single secret of a pipeline. The API never returns secret values, so the output shows\nonly the key and whether it is set, not the stored value."
    },
    {
      "id": "usage",
      "title": "Usage",
      "role": "syntax",
      "text": "[code example]"
    },
    {
      "id": "options",
      "title": "Options",
      "role": "parameters",
      "text": "| Option             | Description                                                 |\n| :----------------- | :---------------------------------------------------------- |\n| `-p`, `--pipeline` | Pipeline to target (default `default`).                     |\n| `--db`             | Database the secret belongs to: a source name, or `target`. |\n\nThis command also accepts the\n[global options](https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di#global-options)."
    },
    {
      "id": "example",
      "title": "Example",
      "role": "example",
      "text": "[code example]"
    }
  ],
  "examples": [
    {
      "id": "usage-ex0",
      "language": "plaintext",
      "code": "redis-di describe-secret <key> [flags]",
      "section_id": "usage"
    },
    {
      "id": "example-ex0",
      "language": "bash",
      "code": "redis-di describe-secret PASSWORD --db target",
      "section_id": "example"
    }
  ]
}