storage

List files in bucket

List files in a bucket with pagination, search, and optional type filter. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).

GET/api/bucket/projects/{projectId}/buckets/{bucketId}/files

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	Project ID.
`bucketId`	string	Yes	Bucket ID.

Query Parameters

Name	Type	Required	Description
`page`	integer	No	Page number (1-based).
`limit`	integer	No	Number of files per page.
`search`	string	No	Search by filename.
`type`	string	No	Filter by MIME type or file type.

SDK setup

Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.

import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");
import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const result = await client.storage.listFiles({
  projectId: "proj_oi68Mel0hclQ",
  bucketId: "iICD7WZjf1iUOCA8"
});
const result = await client.storage.listFiles({
  projectId: "proj_oi68Mel0hclQ",
  bucketId: "iICD7WZjf1iUOCA8"
});

Try It Live

Test this endpoint with your own credentials. Your requests will be sent to the live API.

JWT Bearer Token Use the auth endpoints to obtain a JWT.

Path Parameters

projectId

bucketId

Query Parameters

page

limit

type

No Request Yet

Send a request to see the full inspector

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
}

400Bad request or validation error.

401Authentication required or invalid token.

403Access denied or insufficient permissions.

409Conflict (e.g. resource already exists or state conflict).

429Rate limit exceeded.

500Internal server error.

Errors

Code	Meaning
`400`	Bad request or validation error.
`401`	Authentication required or invalid token.
`403`	Access denied or insufficient permissions.
`409`	Conflict (e.g. resource already exists or state conflict).
`429`	Rate limit exceeded.
`500`	Internal server error.

Run in Postman Download OpenAPI

Next steps

Edit this page on GitHub