Skip to main content

List Buckets

GET https://infrahub-api.nexgencloud.com/v1/object-storage/buckets​

Retrieve a list of all buckets in your Object Storage account, and provides details on each, including their name, region, size, and number of stored objects.


Parameters​

No parameters.


Attributes​

buckets array of objects​

An array of bucket objects containing metadata about each bucket.

Show child attributes
name string​

The name of the bucket.

region string​

The region where the bucket is hosted.

created_at string (date-time)​

Timestamp when the bucket was created.

num_objects integer​

Total number of objects in the bucket.

size_bytes integer​

Cumulative size of all objects in the bucket, in bytes.

size_bytes_actual integer​

Actual storage used in bytes, accounting for storage format and overhead.

Example request
curl -X GET "https://infrahub-api.nexgencloud.com/v1/object-storage/buckets" \
  -H "accept: application/json" \
  -H "api_key: YOUR API KEY"
  • Include an api_key in the header to authenticate your request. Learn more
Response
{
  "buckets": [
    {
      "name": "my-dataset",
      "region": "CANADA-1",
      "created_at": "2025-05-22T10:14:31Z",
      "num_objects": 12,
      "size_bytes": 45789234,
      "size_bytes_actual": 45875200
    }
  ]
}

Returns​

Returns an array of bucket objects containing metadata including name, size, object count, and region location.


Back to top​