Skip to main content

ProvisioningRequest

bucket_namestringrequired

Name of the bucket to be provisioned

org_namestringrequired

Name of the organization where the bucket should be provisioned

org_quota object
limit_bytesint64required

The number of bytes that the organization is allowed to store across all of its buckets. Zero means no limit.

user_idstringrequired

ID of the user who is requesting the bucket

bucket_options object
publicboolean

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

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.

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)

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

user_roleOrgMembership (string)

Role assigned to the user in the organization

Possible values: [Admin, Member]

ProvisioningRequest
{
  "bucket_name": "string",
  "org_name": "string",
  "org_quota": {
    "limit_bytes": 0
  },
  "user_id": "string",
  "bucket_options": {
    "public": true,
    "storage_class": "STANDARD",
    "regions": "string",
    "enable_object_acl": true,
    "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"
      }
    }
  },
  "user_role": "Admin"
}