Skip to content
  • Auto
  • Light
  • Dark
Get Started

Update

Update
client.vals.files.update(stringvalId, FileUpdateParamsparams, RequestOptionsoptions?): idstringlinksLinksnamestringpathstringtypeunionupdatedAtstringversionnumberFileUpdateResponse
put/v2/vals/{val_id}/files

Update a file's content

Parameters
valIdstring
formatuuid
paramspathstringbranch_idstringcontentstringnamestringparent_pathuniontypeunionFileUpdateParams
Hide ParametersShow Parameters
pathstring

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

branch_idstring
optional

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

formatuuid
contentstring
optional

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

minLength0
maxLength80000
namestring
optional

Body param:

minLength1
maxLength48
parent_pathunion
optional
string | null

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

typeunion
optional
"file" | "interval" | "http" | 2 more

Body param:

Hide ParametersShow Parameters
"file"
"interval"
"http"
"email"
"script"
Returns
FileUpdateResponse

A File or Directory's Metadata

Hide ParametersShow Parameters
idstring

The id of the resource

formatuuid
namestring
pathstring
typeunion
"directory" | "file" | "interval" | 3 more
Hide ParametersShow Parameters
"directory"
"file"
"interval"
"http"
"email"
"script"
updatedAtstring
formatdate-time
versionnumber
minimum0
import ValTown from '@valtown/sdk';

const client = new ValTown();

const file = await client.vals.files.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { path: 'path' });

console.log(file.id);
200 Example
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "links": {
    "html": "https://example.com",
    "module": "https://example.com",
    "self": "https://example.com",
    "endpoint": "https://example.com"
  },
  "name": "name",
  "path": "path",
  "type": "directory",
  "updatedAt": "2019-12-27T18:11:19.117Z",
  "version": 0
}