Skip to main content

GetBucketResponse

bucket object
namestring

Name of the bucket

created_atdate-time

RFC3339 formatted timestamp of bucket creation

Example: 2021-09-01T12:00:00Z
sizeint64

Estimated size of the bucket in bytes

object_countint64

Estimated number of objects in the bucket

publicboolean

If set to true, the bucket is publicly accessible

storage_classStorageClass (string)

Storage class for the bucket. Default is STANDARD.

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

regionsRegions (string)

Restricts the regions where bucket data is stored. Default is empty, which means no restrictions. See https://www.tigrisdata.com/docs/objects/object_regions/ for more details.

object_acl_enabledboolean

If set to true, per object ACL is enabled

website object
domain_namestring

Custom domain name for the bucket. Must be a valid fully-qualified domain name (FQDN) and have a CNAME record pointing to the bucket URL.

Example: images.example.com
object_notifications object

Configuration for object event notifications via webhook. Receive HTTP callbacks when objects are created, updated, or deleted in your bucket.

Update behavior (partial updates supported):

  • Omit field entirely: Keeps existing settings unchanged
  • Include only enabled: Toggles notifications on/off while preserving all other config
  • Include any field: Updates specified fields, preserves others (auth not re-required)
  • Remove completely: Send {"enabled": false} with no other fields

Common operations:

// Enable notifications (preserves webhook, filter, auth)
{"enabled": true}

// Disable temporarily (keeps all config for later)
{"enabled": false, "webhook": "https://..."}

// Update webhook only (preserves auth, filter)
{"webhook": "https://new-endpoint.com"}

// Change auth type (replaces entire auth object)
{"auth": {"token": "new-token"}}

// Remove all notifications
{"enabled": false}

Note: Auth credentials are masked in responses. You don't need to re-send them when updating other fields.

enabledbooleanrequired

Enable or disable notifications (webhook required when true)

webhookuri

HTTPS endpoint to receive notification events

Example: https://webhook.example.com/tigris-events
filterstring

SQL WHERE clause to filter which objects trigger notifications (e.g., size comparisons)

Example: size > 1000000
regionstring

Region to process notifications from (defaults to server region)

Example: iad
auth object

Authentication credentials for webhook endpoint

basic_userstring

Basic auth username

basic_passpassword

Basic auth password

tokenpassword

Bearer token for authorization

GetBucketResponse
{
  "bucket": {
    "name": "string",
    "created_at": "2021-09-01T12:00:00Z",
    "size": 0,
    "object_count": 0,
    "public": true,
    "storage_class": "STANDARD",
    "regions": "string",
    "object_acl_enabled": true,
    "website": {
      "domain_name": "images.example.com"
    },
    "object_notifications": {
      "enabled": true,
      "webhook": "https://webhook.example.com/tigris-events",
      "filter": "size > 1000000",
      "region": "iad",
      "auth": {
        "basic_user": "string",
        "basic_pass": "string",
        "token": "string"
      }
    }
  }
}