BlueForge Docs

Storage Usage

View storage bucket statistics for a project, including object counts, total size, and CDN base URL.

Endpoint

MethodPathAuthIdempotent
GET
/api/platform/projects/:id/storage
tenant Beareryes

Parameters

NameTypeRequiredDefaultNotes
id
stringyespath parameter; project ID

Response

{
  projectSlug: string
  buckets: Array<{
    id: string
    name: string
    fullName: string
    objectCount: number
    totalSize: number          // bytes
    createdAt: string          // ISO 8601
  }>
  totalObjects: number
  totalSize: number            // bytes
  cdnBaseUrl: string
}

Examples

curl https://api.blueforge.studio/api/platform/projects/prj_xxx/storage \
  -H "Authorization: Bearer $BF_TENANT_KEY"
import { Client } from "@blueforge/client"

const storage = await client.projects.storage("prj_xxx")
console.log(`Total: ${storage.totalObjects} objects, ${(storage.totalSize / 1024 / 1024).toFixed(1)} MB`)
for (const bucket of storage.buckets) {
  console.log(`  ${bucket.name}: ${bucket.objectCount} objects, ${bucket.totalSize} bytes`)
}

Pitfalls

  • Object counts and sizes are cached and may lag behind real-time state by up to 60 seconds.
  • The
    totalSize
    value is in bytes. Convert to MB/GB for human-readable displays.
  • Deleted objects are removed asynchronously; counts may not update immediately after deletion.
  • The CDN base URL is project-level and shared by all buckets in the project.

See also

  • projects.keys.list — Manage API keys for storage access
  • Storage buckets are project-scoped; see the Storage API documentation for bucket-level operations

Tested against

  • @blueforge/platform-api: 2.4.1
  • Last verified: 2026-07-15