Get Bucket Usage

GET 
/storage/buckets/:bucketName/usage/storage

Returns the amount of storage space and number of files a bucket takes up.

Path Parameters

bucketName stringrequired

The name of the bucket

200: Bucket Storage Usage

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

size integer

The size of the bucket in bytes

size_kb integer

The size of the bucket in kilobytes

num_objects integer

The number of objects in the bucket

timestamp date-time

The time the snapshot was taken

]

meta

object

page_number integer

page_size integer

total_pages integer

total_results integer

{
  "data": [
    {
      "size": 123456,
      "size_kb": 123456,
      "num_objects": 123456,
      "timestamp": "2020-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/storage/buckets/:bucketName/usage/storage' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200

---

{
  "data": [
    {
      "size": 123456,
      "size_kb": 123456,
      "num_objects": 123456,
      "timestamp": "2020-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}