Retrieve Bucket

GET https://infrahub-api.nexgencloud.com/v1/object-storage/buckets/{bucket_name}

Retrieve detailed metadata for a specific bucket in your Object Storage account by name, and provides information including region, creation timestamp, object count, and storage usage.

Path Parameters

---

bucket_name string  required

The name of the bucket to retrieve.

Query Parameters

---

region string  required

The region where the bucket is located.

Attributes

---

The response includes a single bucket object with the following attributes:

Show attributes

name string

The name of the bucket.

---

region string

The region the bucket is hosted in.

---

created_at string (date-time)

Timestamp when the bucket was created.

---

num_objects integer

Number of objects in the bucket.

---

size_bytes integer

Total size of the bucket contents in bytes.

---

size_bytes_actual integer

Actual storage used in bytes after compression or overhead.

Example request

curl -X GET "https://infrahub-api.nexgencloud.com/v1/object-storage/buckets/my-dataset?region=CANADA-1" \
  -H "accept: application/json" \
  -H "api_key: YOUR API KEY"

• Include an api_key in the header to authenticate your request. Learn more

Response

{
  "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 metadata for the specified bucket, including size, object count, and region.

Back to top