• Vault

search

post/vault/api/v1/search/secrets

Search for the user-specific secrets

keywordsstring

Comma or space-separated strings to search in secrets' names. The leading and trailing wildcards for the keywords are implicit.

owner_idarray

List of users IDs that owns secrets.

filterstring

Defines what type of secrets to search for

Enum
  • personal
  • shared
  • readable
  • writable
  • accessible
  • empty string

Responses

Request examples

{
  "keywords": "string",
  "owner_id": [
    "string"
  ],
  "filter": "personal"
}

Response examples

Search successful, return matching secrets without secret data

{
  "count": 123,
  "items": [
    {
      "name": "string",
      "data": {},
      "read_roles": [
        {
          "id": "string",
          "name": "string",
          "deleted": true
        }
      ],
      "write_roles": [
        {
          "id": "string",
          "name": "string",
          "deleted": true
        }
      ],
      "author": "string",
      "path": "string",
      "updated_by": "string",
      "created": "string",
      "updated": "string"
    }
  ]
}

Was this page helpful?