Skip to main content
The GET /v1/account/stats endpoint returns a snapshot of your Virtus Cloud Blob account’s current storage usage, the storage included in your plan, and an itemized billing estimate. Use this endpoint to monitor consumption, build usage dashboards, or trigger alerts when you approach your plan limits. Stats are refreshed every 1 minute. Endpoint: GET https://blob.virtuscloud.app/v1/account/stats

Authentication

Include your API key in the Authorization header:
Authorization: <your-api-key>
See the Authentication page for details.
Response data is cached for 1 minute. If you recently uploaded or deleted objects, the stats may take up to a minute to reflect the change.

Example Request

curl -X GET "https://blob.virtuscloud.app/v1/account/stats" \
  -H "Authorization: <your-api-key>"

Response

status
string
Indicates whether the request succeeded. Returns "success" on success or "error" on failure.
response
object
Example Response (1m cache)
{
  "status": "success",
  "response": {
    "usage": {
      "objects": 0,
      "storage": 0
    },
    "plan": {
      "included": 0
    },
    "billing": {
      "extraStorage": 0,
      "storagePrice": 0,
      "objectsPrice": 0,
      "totalEstimate": 0
    }
  }
}

Troubleshooting

A 401 response means the Authorization header is missing or contains an invalid API key.
// Verify that your API key is correct and included in the Authorization header.
{
  "status": "error",
  "code": "ACCESS_DENIED"
}