Skip to main content
GET
Explore one available Storage workspace.

Authorizations

​
Authorization
string
header
required

Bearer JWT token or API Key (sk-*).

Path Parameters

​
workspaceId
string
required

Query Parameters

​
parentStorageEntryId
string

Current folder id. Omit for root.

​
flat
boolean

Disable implicit parent-folder scoping and use the explorer in flat query mode. Useful together with explicit filters on parentStorageEntryId.

​
storageProviderConfigId
string

Optional storage scope for root exploration. Omit to include every configured storage, pass an empty value for managed default storage, or pass a configured storage id.

​
term
string

Optional name search within the current folder.

​
skip
number

Result offset.

Required range: x >= 0
​
take
number

Result page size. Use 0 with count=true for count-only explorer requests.

Required range: 0 <= x <= 200
​
includeArchived
boolean

Include archived entries in the listing.

​
includeDeleted
boolean

Include permanently deleted tombstones in the listing.

​
includeTotal
boolean

Include total count. Disabled by default because it is expensive for explorer listings.

​
filter
string

QueryWrapper filter tree as a JSON string or bracket-style query object for advanced storage explorer filtering, including JSON metadata lookups.

Example:

"{\"field\":\"metadata\",\"op\":\"contains\",\"value\":{\"source\":\"ui\"}}"

​
sort
string

QueryWrapper sort definition as a JSON string, indexed array query object, array, or legacy CSV. JSON object values should be ASC or DESC. CSV supports descending fields with a leading dash, for example kind,-name.

Example:

"{\"kind\":\"DESC\",\"name\":\"ASC\"}"

​
distinct
string

Optional QueryWrapper DISTINCT ON fields as a JSON array string, indexed array query object, array, or legacy CSV for custom explorer projections.

Example:

"kind"

​
fields
string

Optional QueryWrapper fields selection as a JSON array string, indexed array query object, array, or legacy CSV for custom explorer projections and aggregates.

Example:

"[{\"field\":\"kind\"},{\"fn\":\"SUM\",\"args\":[{\"field\":\"size\"}],\"as\":\"totalSize\"}]"

​
groupBy
string

Optional QueryWrapper GROUP BY fields as a JSON array string, indexed array query object, array, or legacy CSV for custom explorer aggregates.

Example:

"[\"kind\"]"

​
cast
string

Optional QueryWrapper cast mapping as a JSON string or bracket-style query object for aggregate projections.

Example:

"{\"totalSize\":\"BIGINT\"}"

​
count
boolean

Enable total count using the query-service count path.

​
debug
boolean

Enable QueryService debug output for the explorer query.

Response

200

OK.

Last modified on September 5, 2026