Method: projects.subscriptions.modifyAckDeadline

Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level ackDeadlineSeconds used for subsequent messages.

HTTP request

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

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
{
  "ackIds": [
    string
  ],
  "ackDeadlineSeconds": number,
}
Fields
ackIds[]

string

List of acknowledgment IDs.

ackDeadlineSeconds

number

The new ack deadline with respect to the time this request was sent to the Pub/Sub system. For example, if the value is 10, the new ack deadline will expire 10 seconds after the subscriptions.modifyAckDeadline call was made. Specifying zero may immediately make the message available for another pull request. The minimum deadline you can specify is 0 seconds. The maximum deadline you can specify is 600 seconds (10 minutes).

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