Documentation navigation

Objects

List objects

GET/storage/buckets/{bucketName}/objects

List objects in a bucket.

Parameters

ListObjectsParams
bucketNamestring
Bucket name.
prefix?string
Optional object key prefix filter.
cursor?string
Cursor returned from the previous page.
limit?number
Page size. Values are clamped by the API to `1` through `1000`.

Returns

objectsStorageObject[]
Objects in the current page.
nextCursorstring | null
Cursor for the next page, or `null` when no next page exists.
isTruncatedboolean
Whether the result was truncated and another page is available.
countnumber
Number of objects in the current page.