Update schedule
Update schedule
curl --request PUT \
--url https://api.example.com/api/pipeline_schedules/:id \
--header 'Content-Type: application/json' \
--data '
{
"pipeline_schedule": {
"event_matchers": {},
"name": "<string>",
"schedule_interval": "<string>",
"schedule_type": "<string>",
"settings": {
"timeout": 123
},
"sla": 123,
"start_time": {},
"status": "<string>",
"tags": {},
"variables": {}
}
}
'import requests
url = "https://api.example.com/api/pipeline_schedules/:id"
payload = { "pipeline_schedule": {
"event_matchers": {},
"name": "<string>",
"schedule_interval": "<string>",
"schedule_type": "<string>",
"settings": { "timeout": 123 },
"sla": 123,
"start_time": {},
"status": "<string>",
"tags": {},
"variables": {}
} }
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
pipeline_schedule: {
event_matchers: {},
name: '<string>',
schedule_interval: '<string>',
schedule_type: '<string>',
settings: {timeout: 123},
sla: 123,
start_time: {},
status: '<string>',
tags: {},
variables: {}
}
})
};
fetch('https://api.example.com/api/pipeline_schedules/:id', 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://api.example.com/api/pipeline_schedules/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'pipeline_schedule' => [
'event_matchers' => [
],
'name' => '<string>',
'schedule_interval' => '<string>',
'schedule_type' => '<string>',
'settings' => [
'timeout' => 123
],
'sla' => 123,
'start_time' => [
],
'status' => '<string>',
'tags' => [
],
'variables' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/pipeline_schedules/:id"
payload := strings.NewReader("{\n \"pipeline_schedule\": {\n \"event_matchers\": {},\n \"name\": \"<string>\",\n \"schedule_interval\": \"<string>\",\n \"schedule_type\": \"<string>\",\n \"settings\": {\n \"timeout\": 123\n },\n \"sla\": 123,\n \"start_time\": {},\n \"status\": \"<string>\",\n \"tags\": {},\n \"variables\": {}\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.example.com/api/pipeline_schedules/:id")
.header("Content-Type", "application/json")
.body("{\n \"pipeline_schedule\": {\n \"event_matchers\": {},\n \"name\": \"<string>\",\n \"schedule_interval\": \"<string>\",\n \"schedule_type\": \"<string>\",\n \"settings\": {\n \"timeout\": 123\n },\n \"sla\": 123,\n \"start_time\": {},\n \"status\": \"<string>\",\n \"tags\": {},\n \"variables\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/pipeline_schedules/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"pipeline_schedule\": {\n \"event_matchers\": {},\n \"name\": \"<string>\",\n \"schedule_interval\": \"<string>\",\n \"schedule_type\": \"<string>\",\n \"settings\": {\n \"timeout\": 123\n },\n \"sla\": 123,\n \"start_time\": {},\n \"status\": \"<string>\",\n \"tags\": {},\n \"variables\": {}\n }\n}"
response = http.request(request)
puts response.read_bodyinteger
required
Pipeline schedule ID
object
required
Hide payload
Hide payload
array of objects
Deprecated. Used only for maintaining existing legacy event triggers.
string
Trigger names are trimmed before validation. The name must include at least one letter or
number, cannot exceed 255 characters, and must be unique within the pipeline.
string
Required when
schedule_type is time.string
Trigger type. Use
api or time for supported non-legacy triggers. event is deprecated
and only used for existing legacy event triggers.object
Additional settings for the trigger.
Show properties
Show properties
integer
Optional run timeout in seconds. When provided, the value must be a positive integer.
Use
null or omit this field for no timeout.integer
Optional SLA threshold in seconds. When provided, the value must be a positive integer.
Use
0 or null to clear an existing SLA, or omit this field for no SLA change.datetime
Persisted schedule start timestamp. For
@once, this value determines the single run time;
for recurring time schedules, it anchors when the schedule begins.string
array of strings
Non-empty tag names to associate with the trigger. Tag names are trimmed and duplicate names
are ignored before persistence. Each tag name cannot exceed 70 characters.
object
curl --request PUT \
--url 'http://localhost:6789/api/pipeline_schedules/55?api_key=zkWlN0PkIKSN0C11CfUHUj84OT5XOJ6tDZ6bDRO2' \
--header 'OAUTH-TOKEN=some_really_long_string' \
--data '{
"pipeline_schedule": {
"name": "black voice11111",
"schedule_type": "time",
"schedule_interval": "@once",
"start_time": "2023-03-06 04:53:00",
"variables": {
"env": "dev112222",
"test": 11111
},
"sla": 1000,
"settings": {
"allow_blocks_to_fail": true,
"create_initial_pipeline_run": false,
"skip_if_previous_running": true,
"timeout": 3600
}
}
}'
{
"pipeline_schedule": {
"id": 55,
"created_at": "2023-03-08 04:52:54.268096+00:00",
"updated_at": "2023-04-01 00:52:11.753497+00:00",
"name": "black voice11111",
"pipeline_uuid": "example_pipeline",
"schedule_type": "time",
"start_time": "2023-03-06 04:53:00+00:00",
"schedule_interval": "@once",
"status": "inactive",
"variables": {
"env": "dev112222",
"test": 11111
},
"sla": 1000,
"token": "67d62ed3e66143839f58945bb7d16387",
"settings": {
"allow_blocks_to_fail": true,
"create_initial_pipeline_run": false,
"skip_if_previous_running": true,
"timeout": 3600
},
"event_matchers": []
}
}
Was this page helpful?
⌘I
Update schedule
curl --request PUT \
--url https://api.example.com/api/pipeline_schedules/:id \
--header 'Content-Type: application/json' \
--data '
{
"pipeline_schedule": {
"event_matchers": {},
"name": "<string>",
"schedule_interval": "<string>",
"schedule_type": "<string>",
"settings": {
"timeout": 123
},
"sla": 123,
"start_time": {},
"status": "<string>",
"tags": {},
"variables": {}
}
}
'import requests
url = "https://api.example.com/api/pipeline_schedules/:id"
payload = { "pipeline_schedule": {
"event_matchers": {},
"name": "<string>",
"schedule_interval": "<string>",
"schedule_type": "<string>",
"settings": { "timeout": 123 },
"sla": 123,
"start_time": {},
"status": "<string>",
"tags": {},
"variables": {}
} }
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
pipeline_schedule: {
event_matchers: {},
name: '<string>',
schedule_interval: '<string>',
schedule_type: '<string>',
settings: {timeout: 123},
sla: 123,
start_time: {},
status: '<string>',
tags: {},
variables: {}
}
})
};
fetch('https://api.example.com/api/pipeline_schedules/:id', 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://api.example.com/api/pipeline_schedules/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'pipeline_schedule' => [
'event_matchers' => [
],
'name' => '<string>',
'schedule_interval' => '<string>',
'schedule_type' => '<string>',
'settings' => [
'timeout' => 123
],
'sla' => 123,
'start_time' => [
],
'status' => '<string>',
'tags' => [
],
'variables' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/pipeline_schedules/:id"
payload := strings.NewReader("{\n \"pipeline_schedule\": {\n \"event_matchers\": {},\n \"name\": \"<string>\",\n \"schedule_interval\": \"<string>\",\n \"schedule_type\": \"<string>\",\n \"settings\": {\n \"timeout\": 123\n },\n \"sla\": 123,\n \"start_time\": {},\n \"status\": \"<string>\",\n \"tags\": {},\n \"variables\": {}\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.example.com/api/pipeline_schedules/:id")
.header("Content-Type", "application/json")
.body("{\n \"pipeline_schedule\": {\n \"event_matchers\": {},\n \"name\": \"<string>\",\n \"schedule_interval\": \"<string>\",\n \"schedule_type\": \"<string>\",\n \"settings\": {\n \"timeout\": 123\n },\n \"sla\": 123,\n \"start_time\": {},\n \"status\": \"<string>\",\n \"tags\": {},\n \"variables\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/pipeline_schedules/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"pipeline_schedule\": {\n \"event_matchers\": {},\n \"name\": \"<string>\",\n \"schedule_interval\": \"<string>\",\n \"schedule_type\": \"<string>\",\n \"settings\": {\n \"timeout\": 123\n },\n \"sla\": 123,\n \"start_time\": {},\n \"status\": \"<string>\",\n \"tags\": {},\n \"variables\": {}\n }\n}"
response = http.request(request)
puts response.read_body