Skip to main content
POST
/
v2
/
schedules
/
{scheduleId}
/
pause
Pause a Schedule
curl --request POST \
  --url https://qstash-{region}.upstash.io/v2/schedules/{scheduleId}/pause \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://qstash-{region}.upstash.io/v2/schedules/{scheduleId}/pause"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://qstash-{region}.upstash.io/v2/schedules/{scheduleId}/pause', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://qstash-{region}.upstash.io/v2/schedules/{scheduleId}/pause",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://qstash-{region}.upstash.io/v2/schedules/{scheduleId}/pause"

req, _ := http.NewRequest("POST", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://qstash-{region}.upstash.io/v2/schedules/{scheduleId}/pause")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://qstash-{region}.upstash.io/v2/schedules/{scheduleId}/pause")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
When a schedule is paused, the cron trigger will simply be ignored. If the schedule is already paused, this action has no effect.

Authorizations

Authorization
string
header
required

QStash authentication token

Path Parameters

scheduleId
string
required

The ID of the schedule to pause.

Response

200

Schedule paused successfully