Skip to navigation
API ReferenceObject Storage

Set bucket event notifications

Replaces every notification rule of the bucket. Each rule posts upload or delete events, optionally filtered by prefix or suffix, to a webhook URL. Requires scope: object-storage.write.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# BUCKET_NAME: Logical bucket name
curl -X PUT "https://api.ibee.ai/v1/object-storage/buckets/$BUCKET_NAME/notifications?workspace_id=$WORKSPACE_ID" \
  -H "Authorization: Bearer $IBEE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"configs": [{"events": ["upload"]}]}'

Authentication

AuthorizationBearer

IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.

Path parameters

bucket_namestringRequired
Logical bucket name.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

Request

This endpoint expects an object.
configslist of objectsRequired

Response

Set bucket event notifications succeeded.
detailstringOptional

Human-readable result.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
423
Locked Error
503
Service Unavailable Error