Method: schedules.resume

Full name: projects.locations.schedules.resume

Resumes a paused Schedule to start scheduling new runs. Will markSchedule.state to 'ACTIVE'. Only paused Schedule can be resumed.

When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. IfSchedule.catch_up is set up true, all missed runs will be scheduled for backfill first.

Endpoint

posthttps://{service-endpoint}/v1/{name}:resume

Where{service-endpoint} is one of thesupported service endpoints.

Path parameters

namestring

Required. The name of the Schedule resource to be resumed. Format:projects/{project}/locations/{location}/schedules/{schedule}

Request body

The request body contains data with the following structure:

Fields
catchUpboolean

Optional. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. This will also updateSchedule.catch_up field. Default to false.

Response body

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

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-06-27 UTC.