Notifications: insert

Creates a notification subscription for a given bucket. Try it now.

Request

HTTP request

POST https://www.googleapis.com/storage/v1/b/bucket/notificationConfigs

Parameters

Parameter name Value Description
Path parameters
bucket string The parent bucket of the notification.

Request body

In the request body, supply a notification resource with the following properties:

Property name Value Description Notes
Required Properties
topic string The Cloud PubSub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}' writable
Optional Properties
custom_attributes object An optional list of additional attributes to attach to each Cloud PubSub message published for this notification subscription. writable
event_types[] list If present, only send notifications about listed event types. If empty, sent notifications for all event types. writable
object_name_prefix string If present, only apply this notification configuration to object names that begin with this prefix. writable
payload_format string The desired content of the Payload.

Acceptable values are:
  • "JSON_API_V1"
  • "NONE"
writable

Response

If successful, this method returns a notification resource in the response body.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Send feedback about...

Cloud Storage Documentation