Retrieve

API Reference

Vals

Files

Retrieve

client.vals.files.retrieve(stringvalId, FileRetrieveParamsquery, RequestOptionsoptions?): PageCursorURL<idstringlinksLinksnamestringpathstringtypeunionupdatedAtstringversionnumberFileRetrieveResponse>

get/v2/vals/{val_id}/files

Get metadata for files and directories in a val. If path is an empty string, returns files at the root directory.

Parameters

valIdstring

formatuuid

querylimitnumberoffsetnumberpathstringrecursivebooleanbranch_idstringversionnumberFileRetrieveParams

Hide ParametersShow Parameters

limitnumber

Maximum items to return in each paginated response

minimum1

maximum100

offsetnumber

Number of items to skip in order to deliver paginated results

minimum0

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

Id to query

formatuuid

versionnumber

optional

Specific branch version to query

minimum0

Returns

FileRetrieveResponse

A File or Directory's Metadata

Hide ParametersShow Parameters

idstring

The id of the resource

formatuuid

linkshtmlstringmodulestringselfstringendpointstringLinks

Hide ParametersShow Parameters

htmlstring

The URL of this resource on Val Town

formaturi

modulestring

The URL of this resource's source code as a module

formaturi

selfstring

The URL of this resource on this API

formaturi

endpointstring

optional

This resource's web endpoint, where it serves a website or API

formaturi

namestring

pathstring

typeunion

"directory" | "file" | "interval" | 3 more

Hide ParametersShow Parameters

"directory"

"file"

"interval"

"http"

"email"

"script"

updatedAtstring

formatdate-time

versionnumber

minimum0

HTTPTypeScript

import ValTown from '@valtown/sdk';

const client = new ValTown();

// Automatically fetches more pages as needed.
for await (const fileRetrieveResponse of client.vals.files.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
  limit: 1,
  offset: 0,
  path: 'path',
  recursive: true,
})) {
  console.log(fileRetrieveResponse.id);
}

200 Example

{
  "data": [
    {
      "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
    }
  ],
  "links": {
    "self": "https://example.com",
    "next": "https://example.com",
    "prev": "https://example.com"
  }
}