> ## Documentation Index
> Fetch the complete documentation index at: https://docs.everabyte.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Read bucket size

> Returns the total stored size of one bucket. The size counts non-deleted files only; files in trash are excluded.

Required scope: `buckets:read`.



## OpenAPI

````yaml /api-reference/openapi.json get /buckets/size/{bucketId}
openapi: 3.1.0
info:
  title: Everabyte Storage API
  version: '2026.10'
  summary: Company-scoped storage API authenticated with API keys.
  description: >-
    The Everabyte storage API for company workspaces. Every operation here is
    reachable with an API key and has been verified against route registration
    and controller behavior.


    Authentication uses two headers: `X-Public-Key` and `X-Secret-Key`. API-key
    headers are not CORS-allowed, so this API is for server-side use only.


    Response shapes vary by layer. Success responses use `{status, message,
    data}`. Middleware errors use `{status, message, data, code}`. Controller
    errors use `{status, message, error}`. See the Conventions page for details.


    All examples are illustrative. Identifiers, sizes, and timestamps are
    placeholders, not production data.
  contact:
    name: Everabyte Support
    email: support@everabyte.com
    url: https://everabyte.com
  license:
    name: Proprietary
servers:
  - url: https://api.everabyte.io/api
    description: Production
security:
  - PublicKey: []
    SecretKey: []
tags:
  - name: Files
    description: >-
      List, upload, download, update, move, copy, delete, restore, and version
      files.
  - name: Folders
    description: Browse and manage the folder tree inside a bucket.
  - name: Buckets
    description: Discover the buckets a key can reach and read their stored size.
paths:
  /buckets/size/{bucketId}:
    get:
      tags:
        - Buckets
      summary: Read bucket size
      description: >-
        Returns the total stored size of one bucket. The size counts non-deleted
        files only; files in trash are excluded.


        Required scope: `buckets:read`.
      operationId: readBucketSize
      parameters:
        - $ref: '#/components/parameters/BucketId'
      responses:
        '200':
          description: Bucket size.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BucketSizeResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  parameters:
    BucketId:
      name: bucketId
      in: path
      required: true
      description: >-
        Bucket identifier. Read it from the bucket list, or copy it from the
        Everabyte dashboard.
      schema:
        type: string
        format: uuid
  schemas:
    BucketSizeResponse:
      type: object
      required:
        - status
        - message
        - data
      properties:
        status:
          type: integer
          example: 200
        message:
          type: string
          example: Bucket size checked
        data:
          type: object
          required:
            - totalSize
            - totalSizeBytes
          properties:
            totalSize:
              type: string
              description: Human-readable total size, for example `"1.2 GB"`.
            totalSizeBytes:
              type: integer
              description: >-
                Total size in bytes. Counts non-deleted files only; files in
                trash are excluded.
    ErrorEnvelope:
      type: object
      description: >-
        Error shape varies by layer. Middleware errors include `code`;
        controller errors include `error`; framework errors may use
        `statusCode`.
      properties:
        status:
          type: integer
        statusCode:
          type: integer
        message:
          type: string
        error:
          type:
            - string
            - object
            - 'null'
        code:
          type: string
        data:
          type:
            - object
            - array
            - 'null'
      additionalProperties: true
  responses:
    Unauthorized:
      description: Missing, malformed, revoked, or expired credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: >-
        Authorization failure. Stable codes include `API_COMPANY_ONLY`,
        `API_KEY_SURFACE_DENIED`, `API_BUCKET_SCOPE_DENIED`,
        `TRIAL_API_LIMIT_REACHED`, and `DEVICE_BLOCKED`. A missing scope usually
        returns no code.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: Resource not found or not visible to this key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    RateLimited:
      description: >-
        Request rate exceeded. Stable code `API_KEY_RATE_LIMITED`. No
        `Retry-After` header is documented; use exponential backoff with jitter.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    ServerError:
      description: Unexpected server error. Messages are sanitized in production.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    PublicKey:
      type: apiKey
      in: header
      name: X-Public-Key
      description: >-
        Public half of the company API key. Format: `pk_` followed by 64
        hexadecimal characters.
    SecretKey:
      type: apiKey
      in: header
      name: X-Secret-Key
      description: >-
        Secret half of the company API key. Format: `sk_` followed by 64
        hexadecimal characters. Stored as a hash server-side and shown only at
        creation or rotation.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.