Update bucket limits

PATCH /v1/admin/storage/buckets/{bucket}/settings

• Operation ID: updateStorageBucketSettings
• Tags: Storage
• Base URL: http://localhost:8787

Changes fileSizeLimit (bytes, max 5 GiB) and/or allowedMimeTypes (null clears the restriction); omitted fields are kept and at least one is required. Applied with the service role. Audited as storage.configure and emits a dashboard event.

Workflow: Integration guide.

Authentication: staff Bearer JWT with permission storage.configure.

Authentication

• Auth: staff Bearer JWT (Authorization: Bearer <access_token>) with the permissions below.
• Required permissions: storage.configure

Parameters

Name	In	Type	Required	Description
bucket	path	string	yes	One of: "avatars", "store", "assets"

Request body

Required: yes.

Content type: application/json

Schema: object

Field	Type	Required	Description
fileSizeLimit	integer	no	Greater than: 0. Max: 5368709120
allowedMimeTypes	string[] | null	no	-

Responses

200

Updated bucket.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (StorageBucket)

Field	Type	Required	Description
id	string	yes	-
name	string	yes	-
public	boolean	yes	-
file_size_limit	integer | null	yes	Maximum object size in bytes; null means unlimited.
allowed_mime_types	string[] | null	yes	null means any MIME type.

Errors

400

Request validation failed.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ValidationErrorBody)

Field	Type	Required	Description
success	boolean	yes	One of: false
error	object	yes	-
error.name	string	yes	One of: "ZodError"
error.issues	object[]	yes	-
error.issues[].code	string	yes	-
error.issues[].path	(string | number)[]	yes	-
error.issues[].message	string	yes	-

Request validation

{
  "success": false,
  "error": {
    "name": "ZodError",
    "issues": [
      {
        "code": "custom",
        "path": [
          "field"
        ],
        "message": "Invalid value"
      }
    ]
  }
}

401

Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody)

Field	Type	Required	Description
error	string	yes	Stable machine-readable error code, e.g. forbidden, not_found.
details	any	no	Optional structured context. For 403 it is { perm }.

Error response

{
  "error": "missing_token"
}

403

Authenticated but lacking the required permission. details.perm lists the accepted permission keys.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "forbidden",
  "details": {
    "perm": "storage.configure"
  }
}

500

Unexpected server error (internal). No details are returned.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "internal"
}

Examples

curl

curl -X PATCH 'http://localhost:8787/v1/admin/storage/buckets/avatars/settings' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"fileSizeLimit":1,"allowedMimeTypes":["example"]}'

TypeScript

const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow

const response = await fetch("http://localhost:8787/v1/admin/storage/buckets/avatars/settings", {
  method: "PATCH",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "fileSizeLimit": 1,
    "allowedMimeTypes": [
      "example"
    ]
  }),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
  ? undefined
  : response.headers.get("content-type")?.includes("json")
    ? await response.json()
    : await response.text();