v1

latestOpenAPI 3.0.32026-07-26172157253.6 KB
Admin

List Objects in Bucket

get/api/storage/buckets/{bucketName}/objects

Path parameters

bucketNamestring required

Query parameters

prefixstring

Filter objects by key prefix

limitinteger
offsetinteger
searchstring

Search objects by key (partial match)

Response

List of objects in bucket

nextActionsstring

Example response

{
  "data": [
    {
      "bucket": "avatars",
      "key": "user123.jpg",
      "size": 102400,
      "mimeType": "image/jpeg",
      "uploadedAt": "2024-01-15T10:30:00Z",
      "url": "/api/storage/buckets/avatars/objects/user123.jpg"
    }
  ],
  "pagination": {
    "limit": 100,
    "total": 2
  },
  "nextActions": "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."
}