Get files in a storage folder, or all files on a storage

Required roles:

  • can_list_storage_files
get/v1/storages/{storage_id}/files/

Request

Path parameters

storage_idstring required

Query parameters

pathstring
path_separatorstring
directory_pathstring
checksumstring
per_pageinteger

The number of items for each page

pageinteger

Which page number to fetch

scrollboolean

If true passed then uses scroll pagination instead of default one

scroll_idstring

In order to get next batch of results using scroll pagination the scroll_id is required

sortstring

A comma separated list of fieldnames with order. For example - first_name,asc;last_name,desc

idstring

Filter by id

namestring

Filter by name

typestring

Filter by type

statusstring

Filter by status

date_createdstring

Filter by date_created

date_modifiedstring

Filter by date_modified

original_namestring

Filter by original_name

sizestring

Filter by size

asset_idstring

Filter by asset_id

format_idstring

Filter by format_id

include_parent_statusesboolean

Include the statuses of the parent file sets and formats

Headers

App-IDstring required
Auth-Tokenstring required

Response

Returns files

facetsobject
first_urlstring
last_urlstring
next_urlstring
pageinteger
pagesinteger
per_pageinteger
prev_urlstring
scroll_idstring
totalinteger

Changes

No recorded changes to this operation across all 1 revision of this API.