API documentation
  1. Storage
API documentation
  • Introduction
  • Error guide
  • Quickstart guide
  • API Directory
    • Datacenter
    • Bucket
    • File
    • Folder
    • Region
    • Storage
      • Status
        GET
  • Welcome
    GET
  1. Storage

Status

GET
https://api.everabyte.io/api/storage/status

Get Storage Status#

Endpoint: /storage/status
Method: GET

Request Body#

None

Example Request#

GET /storage/status
Content-Type: application/json

Example Success Response (200 OK)#

{
  "status": 200,
  "data": {
    "capacity_bytes": 3513283248128,
    "used_bytes": 0,
    "remaining_bytes": 3513283248128,
    "warning": {
      "is_low": false
    },
    "readable": {
      "capacity": "3.20TB",
      "used": "0B",
      "remaining": "3.20TB"
    }
  }
}

Explanation of Result Variables#

capacity_bytes (number): Total storage capacity available, expressed in bytes.
used_bytes (number): Amount of storage currently in use, expressed in bytes.
remaining_bytes (number): Amount of storage remaining or free, expressed in bytes.
warning.is_low (boolean): Indicates if the remaining storage is low (true) or sufficient (false).
readable.capacity (string): Human-readable format of total storage capacity (e.g., "3.20TB").
readable.used (string): Human-readable format of used storage (e.g., "0B").
readable.remaining (string): Human-readable format of remaining/free storage (e.g., "3.20TB").

Response Codes#

200 OK: Storage status retrieved successfully.
401 Unauthorized: The current user is not authorized to access storage information.
500 Internal Server Error: Unexpected server error.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.everabyte.io/api/storage/status' \
--header 'Authorization: Bearer <token>'

Responses

🟢200Success
application/json
Body

Example
{
    "status": 200,
    "data": {
        "capacity_bytes": 3513283248128,
        "used_bytes": 0,
        "remaining_bytes": 3513283248128,
        "warning": {
            "is_low": false
        },
        "readable": {
            "capacity": "3.20TB",
            "used": "0B",
            "remaining": "3.20TB"
        }
    }
}
Modified at 2025-10-08 22:18:35
Previous
Region
Next
Welcome
Built with