Method: projects.locations.schedules.pause

Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.

HTTP request

POST https://{service-endpoint}/v1beta1/{name}:pause

Where {service-endpoint} is one of the supported service endpoints.

Path parameters



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

Request body

The request body must be empty.

Response body

If successful, the response body is empty.

Authorization scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.schedules.update

For more information, see the IAM documentation.