Files
List files in bucket
GET
/api/bucket/projects/{projectId}/buckets/{bucketId}/filesSDK setup
Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.
import { Configuration, FilesApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const files = new FilesApi(configuration);import { Configuration, FilesApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const files = new FilesApi(configuration);Example request
Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.
const { data: result } = await files.listFiles("proj_o9Qaqg7Fejce", "n0zeTGQG8hquWq7Z");const { data: result } = await files.listFiles("proj_o9Qaqg7Fejce", "n0zeTGQG8hquWq7Z");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 | — |
bucketId | string | Yes | — |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | integer | No | — |
limit | integer | No | — |
search | string | No | — |
type | string | No | — |
Responses
200List of files
json
{
"files": [
{
"_id": "685af8b85d73a104065b6a77",
"name": "example.pdf",
"size": 1024000,
"mimeType": "application/pdf",
"bucket": "65a1b2c3d4e5f6789012345a",
"url": "https://storage.example.com/files/685af8b85d73a104065b6a77",
"createdAt": "2024-01-15T10:00:00.000Z"
}
],
"total": 1,
"page": 1,
"limit": 20
}{
"files": [
{
"_id": "685af8b85d73a104065b6a77",
"name": "example.pdf",
"size": 1024000,
"mimeType": "application/pdf",
"bucket": "65a1b2c3d4e5f6789012345a",
"url": "https://storage.example.com/files/685af8b85d73a104065b6a77",
"createdAt": "2024-01-15T10:00:00.000Z"
}
],
"total": 1,
"page": 1,
"limit": 20
}400—
401—
403—
409—
429—
500—
Errors
| Code | Meaning |
|---|---|
400 | — |
401 | — |
403 | — |
409 | — |
429 | — |
500 | — |