storage

Create a new bucket

Create a new storage bucket in a project. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).

POST/api/bucket/projects/{projectId}/buckets

Authentication

Requires JWT Requires API Key JWT or API Key

Note

This endpoint accepts either JWT Bearer token or API Key. Use Authorization: Bearer YOUR_TOKEN for user context, or X-API-Key: YOUR_KEY for server-to-server. View authentication guide →Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →Include your API key in the X-API-Key: YOUR_KEY header (server-to-server, SDKs). View authentication guide →

Path Parameters

Name	Type	Required	Description
`projectId`	string	Yes	Project ID.

Request Body

Bucket name, isPublic flag, and optional settings.

json

{
  "name": "Johnathan Torp I",
  "isPublic": false,
  "settings": {}
}
{
  "name": "Johnathan Torp I",
  "isPublic": false,
  "settings": {}
}

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.createBucket({
  projectId: "proj_vSYhVw5pkXJ0",
  name: "Cassandra Rosenbaum III",
  isPublic: false,
  settings: "system synthesize"
});
const result = await client.storage.createBucket({
  projectId: "proj_vSYhVw5pkXJ0",
  name: "Cassandra Rosenbaum III",
  isPublic: false,
  settings: "system synthesize"
});

Try It Live

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

API Key (optional)Get your API key from the console

JWT Bearer Token (optional)Use the auth endpoints to obtain a JWT.

Path Parameters

projectId

Request Body (JSON)

No Request Yet

Send a request to see the full inspector

Responses

201Bucket created successfully

json

{
  "success": true,
  "message": "Bucket created successfully",
  "bucket": {
    "_id": "65a1b2c3d4e5f6789012345a",
    "name": "my-bucket",
    "project": "685ad30be129932fbb7a1047",
    "isPublic": false,
    "settings": {},
    "createdAt": "2024-01-15T10:00:00.000Z"
  }
}
{
  "success": true,
  "message": "Bucket created successfully",
  "bucket": {
    "_id": "65a1b2c3d4e5f6789012345a",
    "name": "my-bucket",
    "project": "685ad30be129932fbb7a1047",
    "isPublic": false,
    "settings": {},
    "createdAt": "2024-01-15T10:00:00.000Z"
  }
}

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