Contents x
Bucket Notification Rule Update Command
- Print
- DarkLight
Contents
Bucket Notification Rule Update Command
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
V4.0.2
This command lets you update a notification rule of the given bucket.
Note
To enable this feature, contact the Support team to request access.
Currently, Group admins cannot manage Event Notification rules in a Group member’s account.
Currently, Group admins cannot manage Event Notification rules in a Group member’s account.
b2 bucket notification-rule update [-h] [--event-type EVENT_TYPE]
[--webhook-url WEBHOOK_URL]
[--sign-secret SIGN_SECRET]
[--custom-header CUSTOM_HEADER] [--enable]
[--disable] [--json]
B2_URI ruleName
b2 notification-rule update b2://bucketName/newPath/ ruleName --disable --event-type "b2:ObjectCreated:*" --event-type "b2:ObjectHidden:*"
b2 notification-rule update b2://bucketName/newPath/ ruleName --enable
Required Capabilities
- readBucketNotifications
- writeBucketNotifications
Positional Arguments
- B2_URI
Backblaze B2 URI of the bucket with optional path prefix (for example,b2://bucketName
orb2://bucketName/optionalSubPath/
). - ruleName
The name of the rule.
Named Arguments
- --event-type
The scope of the events (for example,‘b2:ObjectCreated:*’
). You can use this parameter multiple times to set multiple scopes. - --webhook-u
The URL to which the notification should be sent. - --sign-secret
Optional signature key consisting of 32 alphanumeric characters. - --custom-header
Custom header to be sent with the notification. You can use this parameter multiple times to set multiple headers.
Format: HEADER_NAME=VALUE - --enable
Flag that enables the notification rule. - --disable
Flag that disables the notification rule.
Default: True - --json
The output in JSON format to use in scripts.
Default: False
V4.0.1
This command lets you update a notification rule of the given bucket.
Note
To enable this feature, contact the Support team to request access.
Currently, Group admins cannot manage Event Notification rules in a Group member’s account.
Currently, Group admins cannot manage Event Notification rules in a Group member’s account.
b2 bucket notification-rule update [-h] [--event-type EVENT_TYPE]
[--webhook-url WEBHOOK_URL]
[--sign-secret SIGN_SECRET]
[--custom-header CUSTOM_HEADER] [--enable]
[--disable] [--json]
B2_URI ruleName
b2 notification-rule update b2://bucketName/newPath/ ruleName --disable --event-type "b2:ObjectCreated:*" --event-type "b2:ObjectHidden:*"
b2 notification-rule update b2://bucketName/newPath/ ruleName --enable
Required Capabilities
- readBucketNotifications
- writeBucketNotifications
Positional Arguments
- B2_URI
Backblaze B2 URI of the bucket with optional path prefix (for example,b2://bucketName
orb2://bucketName/optionalSubPath/
). - ruleName
The name of the rule.
Named Arguments
- --event-type
The scope of the events (for example,‘b2:ObjectCreated:*’
). You can use this parameter multiple times to set multiple scopes. - --webhook-u
The URL to which the notification should be sent. - --sign-secret
Optional signature key consisting of 32 alphanumeric characters. - --custom-header
Custom header to be sent with the notification. You can use this parameter multiple times to set multiple headers.
Format: HEADER_NAME=VALUE - --enable
Flag that enables the notification rule. - --disable
Flag that disables the notification rule.
Default: True - --json
The output in JSON format to use in scripts.
Default: False
V4.0.0
This command lets you update a notification rule of the given bucket.
Note
To enable this feature, contact the Support team to request access.
Currently, Group admins cannot manage Event Notification rules in a Group member’s account.
Currently, Group admins cannot manage Event Notification rules in a Group member’s account.
b2 bucket notification-rule update [-h] [--event-type EVENT_TYPE]
[--webhook-url WEBHOOK_URL]
[--sign-secret SIGN_SECRET]
[--custom-header CUSTOM_HEADER] [--enable]
[--disable] [--json]
B2_URI ruleName
b2 notification-rule update b2://bucketName/newPath/ ruleName --disable --event-type "b2:ObjectCreated:*" --event-type "b2:ObjectHidden:*"
b2 notification-rule update b2://bucketName/newPath/ ruleName --enable
Required Capabilities
- readBucketNotifications
- writeBucketNotifications
Positional Arguments
- B2_URI
Backblaze B2 URI of the bucket with optional path prefix (for example,b2://bucketName
orb2://bucketName/optionalSubPath/
). - ruleName
The name of the rule.
Named Arguments
- --event-type
The scope of the events (for example,‘b2:ObjectCreated:*’
). You can use this parameter multiple times to set multiple scopes. - --webhook-u
The URL to which the notification should be sent. - --sign-secret
Optional signature key consisting of 32 alphanumeric characters. - --custom-header
Custom header to be sent with the notification. You can use this parameter multiple times to set multiple headers.
Format: HEADER_NAME=VALUE - --enable
Flag that enables the notification rule. - --disable
Flag that disables the notification rule.
Default: True - --json
The output in JSON format to use in scripts.
Default: False
This command is not included in version 2.1.0.
This command is not included in version 2.2.0.
This command is not included in version 2.3.0.
This command is not included in version 2.4.0.
This command is not included in version 2.5.0.
This command is not included in version 2.5.1.
This command is not included in version 3.0.0.
This command is not included in version 3.0.1.
This command is not included in version 3.0.2.
This command is not included in version 3.0.3.
This command is not included in version 3.1.0.
This command is not included in version 3.2.0.
This command is not included in version 3.2.1.
This command is not included in version 3.3.0.
This command is not included in version 3.4.0.
This command is not included in version 3.5.0.
This command is not included in version 3.6.0.
This command is not included in version 3.7.0.
This command is not included in version 3.7.1.
This command is not included in version 3.8.0.
This command is not included in version 3.9.0.
This command is not included in version 3.12.0.
This command is not included in version 3.13.0.
This command is not included in version 3.13.1.
This command is not included in version 3.14.0.
This command is not included in version 3.15.0.
This command is not included in version 3.16.0.
This command is not included in version 3.16.1.
This command is not included in version 3.17.0.
This command is not included in version 3.18.0.
This command is not included in version 3.19.0.
This command is not included in version 3.19.1.
Versions
Was this article helpful?
Thank you for your feedback! Our team will get back to you
How can we improve this article?
Your feedback
Comment
Comment (Optional)
Character limit : 500
Please enter your comment
Email (Optional)
Email
Please enter a valid email