A bucket’s ID, name, visibility, size, and file count.

A bucket in the project, with how many files it holds and their size.

{
  "id": "01m3c081d2wj4g63qcr53pa1yh",
  "name": "invoices",
  "visibility": "public",
  "publicUrl": "https://files.digitospace.com/k3m9q2x7v1c8r4t6w0z5/",
  "bytesStored": 48213,
  "objectCount": 1,
  "webhookUrl": "https://shop.example/hooks/storage",
  "createdAt": "2026-09-26T09:00:00Z",
  "updatedAt": "2026-09-26T09:30:00Z"
}

Fields

idstringRequired

The bucket’s ID. It never changes, even when you rename the bucket. A File’s bucket holds this ID.

namestringRequired

3 to 63 lowercase letters, digits, and single hyphens, starting and ending with a letter or digit. Unique in the project, and the first part of every path in the bucket.

visibilitystringRequired

private, where only an API key or a console session that may read the project’s files can reach them, or public, where anyone with a file’s address can open it.

publicUrlstring

Only on a public bucket. The start of every file’s public address. See Share files publicly.

bytesStorednumberRequired

The size of every file in the bucket, in bytes.

objectCountnumberRequired

How many files the bucket holds.

webhookUrlstring

Only when the bucket has a webhook. The address we call when an upload finishes. See Know when an upload finishes.

createdAtstringRequired

When the bucket was created, as an ISO 8601 date and time.

updatedAtstringRequired

When the bucket, or a file in it, last changed, as an ISO 8601 date and time.

Returned by

Last updated