Get bucket details

GET 
/v1/providers/:provider_id/orgs/:org_id/buckets/:bucket_name

Returns the details of the bucket including its size, object count, and other metadata.

Request

Path Parameters

provider_id stringrequired

Provider ID

org_id stringrequired

Organization ID

bucket_name stringrequired

Bucket name

Responses

200

OK

application/json

Schema

Schema

bucket

object

name string

Name of the bucket

created_at date-time

RFC3339 formatted timestamp of bucket creation

size int64

Estimated size of the bucket in bytes

object_count int64

Estimated number of objects in the bucket

public boolean

If set to true, the bucket is publicly accessible

storage_class StorageClass (string)

Possible values: [STANDARD, STANDARD_IA, GLACIER, GLACIER_IR]

Storage class for the bucket. Default is STANDARD.

object_acl_enabled boolean

If set to true, per object ACL is enabled

Example (from schema)

{
  "bucket": {
    "name": "string",
    "created_at": "2021-09-01T12:00:00Z",
    "size": 0,
    "object_count": 0,
    "public": true,
    "storage_class": "STANDARD",
    "object_acl_enabled": true
  }
}

default

Unexpected error

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "string"
}

Loading...