Delete

API Reference

Vals

Files

Delete

client.vals.files.delete(stringvalId, FileDeleteParamsparams, RequestOptionsoptions?): void

delete/v2/vals/{val_id}/files

Deletes a file or a directory. To delete a directory and all of its children, use the recursive flag. To delete all files, pass in an empty path and the recursive flag.

Parameters

valIdstring

formatuuid

paramspathstringrecursivebooleanbranch_idstringFileDeleteParams

Hide ParametersShow Parameters

pathstring

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

recursiveboolean

Whether to recursively act on all files in the project

branch_idstring

optional

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

formatuuid

HTTPTypeScript

import ValTown from '@valtown/sdk';

const client = new ValTown();

await client.vals.files.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { path: 'path', recursive: true });