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

# Write a file

> Creates or replaces a file with the request body. Creates the missing folders of the path. The body can be up to 128 MiB. A larger body gets `413`. Needs the `sandboxes:files` scope.



## OpenAPI

````yaml /api-reference/openapi.json put /v1/sandboxes/{id}/files
openapi: 3.1.0
info:
  title: VMS API
  version: 1.0.0
  description: >-
    The public API of a VMS workspace. Each request needs an API key of the
    workspace in the Authorization header.
servers:
  - url: https://vms.dev/api
    description: The VMS API
security:
  - apiKey: []
paths:
  /v1/sandboxes/{id}/files:
    put:
      tags:
        - Files
      summary: Write a file
      description: >-
        Creates or replaces a file with the request body. Creates the missing
        folders of the path. The body can be up to 128 MiB. A larger body gets
        `413`. Needs the `sandboxes:files` scope.
      operationId: updateFile
      parameters:
        - in: path
          name: id
          schema:
            type: string
            example: sbx_06d8k3m7q2v9x4b1n5c0e8f2ja
          required: true
        - in: query
          name: path
          schema:
            $ref: '#/components/schemas/AbsolutePath'
            description: The absolute path in the sandbox.
            example: /home/user/app/index.ts
          required: true
          description: The absolute path in the sandbox.
        - in: query
          name: mode
          schema:
            $ref: '#/components/schemas/FileMode'
            description: >-
              The octal mode of the file, such as 0755. A new file gets 0644 by
              default, and a replaced file keeps its mode.
          description: >-
            The octal mode of the file, such as 0755. A new file gets 0644 by
            default, and a replaced file keeps its mode.
      requestBody:
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
      responses:
        '200':
          description: The file.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SandboxFileOutput'
        '400':
          description: The request is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The API key is missing, not correct, revoked, or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The API key does not have the scope of the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: >-
            The workspace has no sandbox with this ID, or no file or folder has
            this path.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            The path is a folder, a folder in the path is a file, or the sandbox
            is not running (`sandbox_not_running`), is starting
            (`sandbox_starting`), or is stopping (`sandbox_stopping`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: The API key sent more than 1,200 requests in one minute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Could not connect to the sandbox.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    AbsolutePath:
      type: string
      minLength: 1
      maxLength: 4096
      pattern: ^\/
    FileMode:
      type: string
      pattern: ^0[0-7]{3,4}$
      description: An octal mode, such as 0644.
    SandboxFileOutput:
      type: object
      properties:
        sandboxId:
          type: string
        path:
          $ref: '#/components/schemas/AbsolutePath'
        bytes:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        mode:
          $ref: '#/components/schemas/FileMode'
        modifiedAt:
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
      required:
        - sandboxId
        - path
        - bytes
        - mode
        - modifiedAt
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: no_capacity
            message:
              type: string
            requestId:
              type:
                - string
                - 'null'
            retryAfterSeconds:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            sandboxId:
              description: The sandbox that the error is about.
              type: string
          required:
            - code
            - message
            - requestId
          additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: An API key that starts with vms_. Make one in Settings > API keys.

````

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