Buckets
List buckets in a project
List all storage buckets in a project with pagination and search. Accepts: OrgBearerAuth (for admin users), ProjectBearerAuth (JWT for authenticated users), or ApiKeyAuth (X-API-Key for programmatic access). Both ProjectBearerAuth and ApiKeyAuth are fully implemented.
GET
/api/bucket/projects/{projectId}/bucketsSDK setup
Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.
import { Configuration, BucketsApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const buckets = new BucketsApi(configuration);import { Configuration, BucketsApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const buckets = new BucketsApi(configuration);Example request
Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.
const { data: result } = await buckets.listBuckets("proj_DkbS1tw9ro41");const { data: result } = await buckets.listBuckets("proj_DkbS1tw9ro41");Playground
liveTest this endpoint with your own credentials. Your requests will be sent to the live API.
Use the auth endpoints to obtain a JWT.
No Request Yet
Send a request to see the full inspector
Authentication
Requires JWT
Note
Include your JWT in the
Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | - |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | integer | No | - |
limit | integer | No | - |
search | string | No | - |
Responses
200List of buckets
json
{
"success": true,
"buckets": [
{
"_id": "65a1b2c3d4e5f6789012345a",
"name": "my-bucket",
"project": "65f1a2b3c4d5e6f7a8b9c0d1",
"isPublic": false,
"createdAt": "2024-01-15T10:00:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1,
"totalPages": 1
}
}{
"success": true,
"buckets": [
{
"_id": "65a1b2c3d4e5f6789012345a",
"name": "my-bucket",
"project": "65f1a2b3c4d5e6f7a8b9c0d1",
"isPublic": false,
"createdAt": "2024-01-15T10:00:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1,
"totalPages": 1
}
}400-
401-
403-
409-
429-
500-
Errors
| Code | Meaning |
|---|---|
400 | - |
401 | - |
403 | - |
409 | - |
429 | - |
500 | - |