---
title: "POST /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause"
method: POST
path: "/v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause"
tags: ["projects"]
---

# POST /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause

`POST /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause`

## Request

- Base URL: `https://aiplatform.googleapis.com`
- URL: `https://aiplatform.googleapis.com/v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause`
- Auth: OAuth 2 and OAuth 2
  - Implicit: `https://accounts.google.com/o/oauth2/auth`
  - Scopes: `https://www.googleapis.com/auth/cloud-platform`
  - Authorization code: `https://accounts.google.com/o/oauth2/auth`
  - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform`

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.

## Path parameters

- `projectsId` string, required
- `locationsId` string, required
- `schedulesId` string, required

## Request body

- GoogleCloudAiplatformV1PauseScheduleRequest: Request message for ScheduleService.PauseSchedule.

## Response `200`

Successful response

- GoogleProtobufEmpty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

---

[API](https://skmtc.dev/google/apis/aiplatform.md) - [All operations](https://skmtc.dev/google/apis/aiplatform/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/aiplatform/revisions/3aca3b348f0c?raw)