Skip to main content
GET
List Objects in Bucket

Authorizations

x-api-key
string
header
required

Path Parameters

bucketName
string
required
Pattern: ^[a-zA-Z0-9_-]+$

Query Parameters

prefix
string

Filter objects by key prefix

limit
integer
default:100
Required range: 1 <= x <= 1000
offset
integer
default:0
Required range: x >= 0

Search objects by key (partial match)

Response

200 - application/json

List of objects in bucket

data
object[]
pagination
object
nextActions
string
Example:

"You can use PUT /api/storage/buckets/:bucketName/objects/:objectKey to upload with a specific key, or POST /api/storage/buckets/:bucketName/objects to upload with auto-generated key, and GET /api/storage/buckets/:bucketName/objects/:objectKey to download an object."