Skip to main content

UpdateBucketRequest

publicboolean

If set to true, the bucket will be publicly accessible. Default is false.

enable_object_aclboolean

If set to true, per object ACL will be enabled. Default is false.

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)

webhookstring<uri>

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
auth object

Authentication credentials for webhook endpoint

basic_userstring

Basic auth username

basic_passstring<password>

Basic auth password

tokenstring<password>

Bearer token for authorization

regionsRegions (string)

Restricts the regions where bucket data is stored. Default is empty, which means no restrictions (global distribution).

Accepted values:

  • Specific region(s): "iad", "sjc", "iad,sjc,lhr" (comma-separated)
  • No restrictions (global distribution): "global"

If you want to remove existing region restrictions, you can set the value to "global".

See https://www.tigrisdata.com/docs/objects/object_regions/ for more details.

UpdateBucketRequest
{
  "public": true,
  "enable_object_acl": true,
  "object_notifications": {
    "enabled": true,
    "webhook": "https://webhook.example.com/tigris-events",
    "filter": "size > 1000000",
    "auth": {
      "basic_user": "string",
      "basic_pass": "string",
      "token": "string"
    }
  },
  "regions": "string"
}