vals

Changed on

Update a file's content

put/v2/vals/{val_id}/files

Request

  • Base URL
    https://api.val.town
  • URL
    https://api.val.town/v2/vals/{val_id}/files
  • Auth
    none declared

Path parameters

val_idstring uuid required

Id of a val

Query parameters

branch_idstring uuid

The specified branch of the resource. Defaults to main if not provided.

pathstring required

Path to a file or directory (e.g. 'dir/subdir/file.ts'). Pass in an empty string to represent the root directory.

Request body

contentstring

File and val content. An empty string will create an empty file. When creating a directory, the content should be null or undefined.

type'file' | 'interval' | 'http' | 'email' | 'script'
parent_pathstring nullable

Path to the directory you'd like to move this file to (e.g. 'folder1/folder2')

namestring

Response

A File or Directory's Metadata

namestring required
idstring uuid required

The id of the resource

pathstring required
versioninteger required
updatedAtstring date-time required
type'directory' | 'file' | 'interval' | 'http' | 'email' | 'script' required

Changes

  • 8f22304950ddRevision changes
    • breaking

      request body became required

  • 7ca4c991c6ccRevision changes
    • breaking

      the / request property type changed from string to no type

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status