Buckets

Retrieve a bucket

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

get/object-storage/buckets/{bucket_name}

Request

  • Base URL: https://infrahub-api.nexgencloud.com/v1
  • URL: https://infrahub-api.nexgencloud.com/v1/object-storage/buckets/{bucket_name}
  • Auth: API key in header api_key

Path parameters

bucket_namestring required

Name of the bucket.

Query parameters

regionstring required

Filter results to a specific region (e.g. CANADA-1, NORWAY-1).

Response

OK

created_atstring date-time

ISO 8601 UTC timestamp marking when the resource was created.

endpointstring

Bucket endpoint URL. Use this with the S3 protocol.

namestring

Name of the object storage bucket.

num_objectsinteger

Number of objects.

region'CANADA-1'
size_bytesinteger

Accumulated size in bytes.

size_bytes_actualinteger

Size utilized in bytes.

Example response

{
  "region": "CANADA-1"
}

Changes

No recorded changes to this operation across all 1 revision of this API.