> ## Documentation Index
> Fetch the complete documentation index at: https://hyperbrowser.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get list of vaults

> List your team's vaults.

See the [vaults guide](/docs/sandboxes/vaults) for SDK and CLI examples.


## OpenAPI

````yaml openapi.json GET /api/vaults
openapi: 3.0.1
info:
  title: Hyperbrowser API
  version: 1.0.0
servers:
  - url: https://api.hyperbrowser.ai
    description: Production server
security: []
paths:
  /api/vaults:
    get:
      summary: List vaults
      description: >-
        Lists your team's vaults, sorted by name, with their entries. Secrets
        are enabled for teams on request; please contact support to enable them
        (otherwise 403 SECRETS_FEATURE_DISABLED). Restricted API keys need the
        secrets.read scope. When you're signed in rather than using an API key,
        you must be a team owner or admin (otherwise 403
        SECRETS_ADMIN_REQUIRED).
      operationId: listVaults
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          description: Vaults per page.
        - name: search
          in: query
          required: false
          schema:
            type: string
            maxLength: 256
          description: Only vaults whose name contains this text, ignoring case.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VaultListResponse'
        '400':
          description: Invalid query parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretErrorResponse'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretErrorResponse'
        '403':
          description: >-
            API_KEY_SCOPE_DENIED (the API key lacks a required scope),
            SECRETS_FEATURE_DISABLED, or SECRETS_ADMIN_REQUIRED.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretErrorResponse'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    VaultListResponse:
      type: object
      properties:
        vaults:
          type: array
          items:
            $ref: '#/components/schemas/Vault'
        totalCount:
          type: integer
        page:
          type: integer
        perPage:
          type: integer
      required:
        - vaults
        - totalCount
        - page
        - perPage
    SecretErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code, such as SECRET_NOT_FOUND.
        message:
          type: string
        error:
          type: string
          description: >-
            Set instead of `code` by authentication and API key scope errors
            (API_KEY_SCOPE_DENIED).
        requiredScopes:
          type: array
          items:
            type: string
          description: The scope the API key is missing, with API_KEY_SCOPE_DENIED.
        retryable:
          type: boolean
          description: >-
            Whether repeating the same request can succeed. Set on delivery
            errors.
        details:
          type: object
          additionalProperties: true
          description: >-
            Extra information for some codes, such as `origin` for
            CREDENTIAL_ORIGIN_NOT_ALLOWED or `pages` for
            CREDENTIAL_PAGE_AMBIGUOUS.
      description: >-
        HTTP failure. Secret errors include `code` and `message`; request
        validation errors include only `message`; API key scope errors include
        `error`, `message` and `requiredScopes`.
    Vault:
      type: object
      description: A named set of environment variables. Holds no values.
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{0,127}$
          description: >-
            1-128 letters, digits, `_` or `-`, starting with a letter or digit.
            Unique within your team.
        description:
          type: string
          maxLength: 1024
        source:
          $ref: '#/components/schemas/VaultSource'
        entries:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/VaultEntry'
          description: Environment variable name to entry.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - name
        - description
        - entries
        - createdAt
        - updatedAt
    VaultSource:
      type: object
      description: >-
        Where the vault's values come from. `stored`: your secrets. `1password`:
        a linked 1Password vault, read with the service account token in
        `tokenSecret`. Treat a missing `source` as `stored`.
      properties:
        type:
          type: string
          enum:
            - stored
            - 1password
        tokenSecret:
          type: object
          description: The `op_token` secret, for 1Password vaults.
          properties:
            name:
              type: string
            secretId:
              type: string
              format: uuid
          required:
            - name
            - secretId
        vault:
          type: string
          description: The 1Password vault's name or ID, for 1Password vaults.
      required:
        - type
    VaultEntry:
      description: >-
        An entry as returned. A stored vault's entry has the secret's `name`,
        `secretId` and pinned `version` (`null` follows the latest). A 1Password
        vault's entry has `item`, `section`, `field` and the `reference` built
        from them.
      type: object
      properties:
        name:
          type: string
        secretId:
          type: string
          format: uuid
        version:
          type: integer
          nullable: true
        item:
          type: string
        section:
          type: string
        field:
          type: string
        reference:
          type: string
          description: The `op://` reference read from 1Password.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.