> ## 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.

# Get path metadata

> Get metadata for a file or directory.

> [accordion] Errors
>
> | Status | Meaning |
> | - | - |
> | `401` | The token is missing or wrong |
> | `403` | A policy or mount mode refused the call |
> | `404` | The workspace, session, job or file does not exist |
> | `422` | Validation Error |
> | `429` | Past a rate limit, or a new session past max\_sessions |
> | `413` | The request body, multipart part, or stdin exceeds its size limit. |
> | `500` | The job or server operation failed internally. Inspect detail and server logs before retrying. |
> | `507` | The filesystem operation exceeds its storage capacity or quota. |
>
> 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 post /v1/workspaces/{workspace_id}/vfs/stat
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/workspaces/{workspace_id}/vfs/stat:
    post:
      tags:
        - VFS
      summary: Get path metadata
      description: Get metadata for a file or directory.
      operationId: endpoint_v1_workspaces__workspace_id__vfs_stat_post
      parameters:
        - $ref: '#/components/parameters/workspaceId'
        - $ref: '#/components/parameters/sessionId'
        - name: explain
          in: query
          description: Return what the call would do without running it.
          required: false
          schema:
            type: boolean
            default: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                path:
                  type: string
                nofollow:
                  type: boolean
              required:
                - path
            example:
              path: /hello.txt
      responses:
        '200':
          description: What the call returns; with explain=true, its explanation
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    description: A FileStat.
                  - $ref: '#/components/schemas/VfsExplanation'
components:
  parameters:
    workspaceId:
      name: workspace_id
      in: path
      required: true
      description: Workspace ID.
      schema:
        type: string
      example: demo
    sessionId:
      name: session_id
      in: query
      required: false
      description: Session ID to use. If omitted, the default session is used.
      schema:
        type: string
      example: analysis
  schemas:
    VfsExplanation:
      allOf:
        - $ref: '#/components/schemas/Explanation'
        - type: object
          properties:
            call:
              type: string
            paths:
              items:
                type: string
              type: array
            error:
              type: string
              description: The errno name the call would raise, empty when it runs.
      title: VFS explanation
    Explanation:
      type: object
      description: >-
        Policy evaluation for a request without executing it. Returned when
        `explain=true`.
      properties:
        type:
          type: string
          description: line, command or vfs.
        outcome:
          type: string
          enum:
            - ALLOW
            - DENY
            - ASK
        reason:
          type: string
          description: Reason returned by the policy that determined the outcome.
        source:
          type: string
          description: Where in the profile the deciding rule is written.
        answers:
          type: array
          items:
            type: object
          description: Evaluation results from each policy.
        refusal:
          anyOf:
            - type: object
            - type: 'null'
      required:
        - outcome
  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.