Method: projects.subscriptions.modifyPushConfig

Modifies the PushConfig for a specified subscription.

This may be used to change a push subscription to a pull one (signified by an empty PushConfig) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the PushConfig.

HTTP request

POST https://pubsub.googleapis.com/v1/{subscription}:modifyPushConfig

Path parameters

Parameters
subscription

string

The name of the subscription. Format is projects/{project}/subscriptions/{sub}.

Request body

The request body contains data with the following structure:

JSON representation
{
  "pushConfig": {
    object(PushConfig)
  },
}
Fields
pushConfig

object(PushConfig)

The push configuration for future deliveries.

An empty pushConfig indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if subscriptions.pull is not called.

Response body

If successful, the response body will be empty.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

Try it!

Send feedback about...

Cloud Pub/Sub