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

# List VFS types

> List supported VFS configuration types and their fields. Available types depend on the server.

> [accordion] Errors
>
> | Status | Meaning |
> | - | - |
> | `401` | The token is missing or wrong |
> | `429` | Past a rate limit, or a new session past max\_sessions |
> | `501` | The server requires accounts; saved configs are kept only on a server of one account |
>
> See [error examples and recovery steps](https://docs.mirage.strukto.ai/api/errors.md). The [complete OpenAPI contract](https://github.com/strukto-ai/mirage/blob/main/docs/openapi.yaml) includes every response schema.


## OpenAPI

````yaml /openapi.yaml get /v1/vfs/types
openapi: 3.2.0
info:
  title: Mirage API
  version: '0.1'
servers:
  - url: http://127.0.0.1:8765
    description: A local server on its default port
security:
  - bearerAuth: []
tags:
  - name: Workspace operations
    x-group: Workspaces
  - name: Workspaces
    x-group: Lifecycle
    parent: Workspace operations
  - name: Sessions
  - name: Shell
    parent: Workspace operations
  - name: VFS
    parent: Workspace operations
  - name: Tools
  - name: Documents
    x-group: Agent Instructions
    parent: Workspace operations
  - name: Snapshots
  - name: Templates
    parent: Configuration
  - name: Saved VFS
    x-group: VFS
    parent: Configuration
  - name: Saved CLIs
    x-group: CLI
    parent: Configuration
  - name: Saved runtimes
    x-group: Runtime
    parent: Configuration
  - name: Saved machines
    x-group: Machine
    parent: Configuration
  - name: Configuration
  - name: Policies
    parent: Configuration
  - name: Asks
    parent: Workspace operations
    x-group: Approval requests
  - name: Lines
    parent: Workspace operations
    x-group: Commands
  - name: Jobs
    parent: Workspace operations
  - name: Processes
    parent: Workspace operations
  - name: Machines
    parent: Workspace operations
  - name: Server
  - name: Service
    parent: Server
  - name: Daemon
    parent: Server
  - name: Auth
paths:
  /v1/vfs/types:
    get:
      tags:
        - Saved VFS
      summary: List VFS types
      description: >-
        List supported VFS configuration types and their fields. Available types
        depend on the server.
      operationId: list_types_v1_vfs_types_get
      responses:
        '200':
          description: OK
          content:
            application/json:
              example:
                s3:
                  - name: timeout
                    type: number
                    secret: false
                    required: false
                    default: 30
                  - name: region
                    type: string
                    secret: false
                    required: false
                  - name: aws_access_key_id
                    type: string
                    secret: true
                    required: false
                  - name: aws_secret_access_key
                    type: string
                    secret: true
                    required: false
                  - name: aws_session_token
                    type: string
                    secret: true
                    required: false
                  - name: aws_profile
                    type: string
                    secret: false
                    required: false
                  - name: bucket
                    type: string
                    secret: false
                    required: true
                  - name: endpoint_url
                    type: string
                    secret: false
                    required: false
                  - name: path_style
                    type: boolean
                    secret: false
                    required: false
                    default: false
                  - name: proxy
                    type: string
                    secret: true
                    required: false
                  - name: key_prefix
                    type: string
                    secret: false
                    required: false
                  - name: default_content_type
                    type: string
                    secret: false
                    required: false
              schema:
                $ref: '#/components/schemas/TypeTable'
components:
  schemas:
    TypeTable:
      type: object
      description: Supported configuration types and their fields, indexed by type name.
      additionalProperties:
        type: array
        items:
          $ref: '#/components/schemas/TypeField'
    TypeField:
      type: object
      properties:
        name:
          type: string
          description: Field name to use in `fields`.
        type:
          type: string
          enum:
            - string
            - number
            - boolean
            - list
            - object
        secret:
          type: boolean
          description: Secret value. Accepted in writes and omitted from read responses.
        required:
          type: boolean
        options:
          type: array
          items:
            type: string
          description: The values the field takes, when it is a choice.
        description:
          type: string
        default:
          anyOf:
            - type: string
            - type: number
            - type: boolean
        group:
          type: string
          description: The section a form shows the field under.
      required:
        - name
        - type
        - secret
        - required
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        The server's token (MIRAGE_AUTH_TOKEN) or a JWT. A daemon in the default
        local mode with no token accepts requests without one.

````

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