Skip to main content
GET
/
api
/
storage
/
buckets
/
{bucketName}
/
objects
List Objects in Bucket
curl --request GET \
  --url https://api.example.com/api/storage/buckets/{bucketName}/objects \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "bucket": "avatars",
      "key": "users/user123.jpg",
      "size": 102400,
      "mimeType": "image/jpeg",
      "uploadedAt": "2024-01-15T10:30:00Z",
      "url": "/api/storage/buckets/avatars/objects/users/user123.jpg"
    },
    {
      "bucket": "avatars",
      "key": "users/user456.png",
      "size": 204800,
      "mimeType": "image/png",
      "uploadedAt": "2024-01-16T11:00:00Z",
      "url": "/api/storage/buckets/avatars/objects/users/user456.png"
    }
  ],
  "pagination": {
    "offset": 0,
    "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."
}

Documentation Index

Fetch the complete documentation index at: https://docs.insforge.dev/llms.txt

Use this file to discover all available pages before exploring further.

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
string

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."