List Fileset Files

GET

https://host.com/apis/files/v2/workspaces/:workspace/filesets/:name/files

GET

/apis/files/v2/workspaces/:workspace/filesets/:name/files

$ curl https://host.com/apis/files/v2/workspaces/workspace/filesets/name/files \
>      -H "Content-Type: application/json"

1 {
2   "data": [
3     {
4       "file_ref": "fileset1234/file5678",
5       "file_url": "https://storage.nemo-platform.com/workspaces/ws-9876/filesets/photos/file5678.jpg",
6       "path": "photos/vacation/2023/beach.jpg",
7       "size": 2456789,
8       "cache_status": "cached"
9     },
10     {
11       "file_ref": "fileset1234/file5679",
12       "file_url": "https://storage.nemo-platform.com/workspaces/ws-9876/filesets/photos/file5679.png",
13       "path": "photos/vacation/2023/mountains.png",
14       "size": 1345678,
15       "cache_status": "not_cached"
16     },
17     {
18       "file_ref": "fileset1234/file5680",
19       "file_url": "https://storage.nemo-platform.com/workspaces/ws-9876/filesets/photos/file5680.mov",
20       "path": "photos/vacation/2023/video.mov",
21       "size": 98765432,
22       "cache_status": "caching"
23     },
24     {
25       "file_ref": "fileset1234/file5681",
26       "file_url": "https://external-storage.com/workspaces/ws-9876/filesets/photos/file5681.tiff",
27       "path": "photos/vacation/2023/raw_image.tiff",
28       "size": 4567890,
29       "cache_status": "not_cacheable"
30     },
31     {
32       "file_ref": "fileset1234/file5682",
33       "file_url": "https://external-storage.com/workspaces/ws-9876/filesets/photos/file5682.gif",
34       "path": "photos/vacation/2023/animated.gif",
35       "size": 123456,
36       "cache_status": null
37     }
38   ]
39 }

List Files in Fileset.

Returns a list of files stored in the specified fileset. Optionally filter by path prefix to list files under a specific directory.

Each file includes a cache_status field:

“not_cacheable”: File is on default storage, caching not applicable
“cached”: File exists in cache storage
“caching”: File is currently being downloaded and cached
“not_cached”: File not in cache, will be cached on next download
null: External storage, but cache status not checked (use include_cache_status=true)

List Files in Fileset. Returns a list of files stored in the specified fileset. Optionally filter by path prefix to list files under a specific directory. Each file includes a cache_status field: - "not_cacheable": File is on default storage, caching not applicable - "cached": File exists in cache storage - "caching": File is currently being downloaded and cached - "not_cached": File not in cache, will be cached on next download - null: External storage, but cache status not checked (use include_cache_status=true)

Path parameters

workspacestringRequired

namestringRequired

Query parameters

pathstringOptional

Filter files by path prefix

include_cache_statusbooleanOptionalDefaults to false

Check and return cache status for each file. When false, storage files return null for cache_status.

Response

Successful Response

datalist of objects

Errors

422

Unprocessable Entity Error