Method: projects.subscriptions.modifyPushConfig

Modifies thePushConfig for a specified subscription.

This may be used to change a push subscription to a pull one (signified by an emptyPushConfig) 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 thePushConfig.

HTTP request


Path parameters

Parameters
subscription

string

Required. The name of the subscription. Format isprojects/{project}/subscriptions/{sub}.

Request body

The request body contains data with the following structure:

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

object (PushConfig)

Required. The push configuration for future deliveries.

An emptypushConfig 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 ifsubscriptions.pull orStreamingPull is not called.

Response body

If successful, the response body is an empty JSON object.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see theAuthentication Overview.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-08-22 UTC.