Stay organized with collections
Save and categorize content based on your preferences.
Full name: projects.locations.schedules.resume
Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.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. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first.
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
catchUp
boolean
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 update Schedule.catch_up field. Default to false.
Response body
If successful, the response body is an empty JSON object.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[],[],null,["# Method: schedules.resume\n\n**Full name**: projects.locations.schedules.resume\n\nResumes a paused Schedule to start scheduling new runs. Will mark [Schedule.state](/vertex-ai/docs/reference/rest/v1/projects.locations.schedules#Schedule.FIELDS.state) to 'ACTIVE'. Only paused Schedule can be resumed.\n\nWhen 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. If [Schedule.catch_up](/vertex-ai/docs/reference/rest/v1/projects.locations.schedules#Schedule.FIELDS.catch_up) is set up true, all missed runs will be scheduled for backfill first. \n\n### Endpoint\n\npost `https:``/``/{service-endpoint}``/v1``/{name}:resume` \nWhere `{service-endpoint}` is one of the [supported service endpoints](/vertex-ai/docs/reference/rest#rest_endpoints).\n\n### Path parameters\n\n`name` `string` \nRequired. The name of the Schedule resource to be resumed. Format: `projects/{project}/locations/{location}/schedules/{schedule}`\n\n### Request body\n\nThe request body contains data with the following structure:\nFields `catchUp` `boolean` \nOptional. 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 update [Schedule.catch_up](/vertex-ai/docs/reference/rest/v1/projects.locations.schedules#Schedule.FIELDS.catch_up) field. Default to false. \n\n### Response body\n\nIf successful, the response body is an empty JSON object."]]
