Create Schedule
curl --request POST \
--url https://api.example.com/schedules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"cron_expr": "<string>",
"endpoint": "<string>",
"method": "POST",
"description": "<string>",
"payload": {},
"timezone": "UTC",
"timeout_seconds": 3600,
"max_retries": 0,
"retry_delay_seconds": 60
}
'import requests
url = "https://api.example.com/schedules"
payload = {
"name": "<string>",
"cron_expr": "<string>",
"endpoint": "<string>",
"method": "POST",
"description": "<string>",
"payload": {},
"timezone": "UTC",
"timeout_seconds": 3600,
"max_retries": 0,
"retry_delay_seconds": 60
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
cron_expr: '<string>',
endpoint: '<string>',
method: 'POST',
description: '<string>',
payload: {},
timezone: 'UTC',
timeout_seconds: 3600,
max_retries: 0,
retry_delay_seconds: 60
})
};
fetch('https://api.example.com/schedules', 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/schedules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'cron_expr' => '<string>',
'endpoint' => '<string>',
'method' => 'POST',
'description' => '<string>',
'payload' => [
],
'timezone' => 'UTC',
'timeout_seconds' => 3600,
'max_retries' => 0,
'retry_delay_seconds' => 60
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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/schedules"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"cron_expr\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"method\": \"POST\",\n \"description\": \"<string>\",\n \"payload\": {},\n \"timezone\": \"UTC\",\n \"timeout_seconds\": 3600,\n \"max_retries\": 0,\n \"retry_delay_seconds\": 60\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.post("https://api.example.com/schedules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"cron_expr\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"method\": \"POST\",\n \"description\": \"<string>\",\n \"payload\": {},\n \"timezone\": \"UTC\",\n \"timeout_seconds\": 3600,\n \"max_retries\": 0,\n \"retry_delay_seconds\": 60\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/schedules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"cron_expr\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"method\": \"POST\",\n \"description\": \"<string>\",\n \"payload\": {},\n \"timezone\": \"UTC\",\n \"timeout_seconds\": 3600,\n \"max_retries\": 0,\n \"retry_delay_seconds\": 60\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"method": "<string>",
"endpoint": "<string>",
"cron_expr": "<string>",
"timezone": "<string>",
"timeout_seconds": 123,
"max_retries": 123,
"retry_delay_seconds": 123,
"enabled": true,
"description": "<string>",
"payload": {},
"next_run_at": 123,
"created_at": 123,
"updated_at": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Schedules
Create Schedule
POST
/
schedules
Create Schedule
curl --request POST \
--url https://api.example.com/schedules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"cron_expr": "<string>",
"endpoint": "<string>",
"method": "POST",
"description": "<string>",
"payload": {},
"timezone": "UTC",
"timeout_seconds": 3600,
"max_retries": 0,
"retry_delay_seconds": 60
}
'import requests
url = "https://api.example.com/schedules"
payload = {
"name": "<string>",
"cron_expr": "<string>",
"endpoint": "<string>",
"method": "POST",
"description": "<string>",
"payload": {},
"timezone": "UTC",
"timeout_seconds": 3600,
"max_retries": 0,
"retry_delay_seconds": 60
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
cron_expr: '<string>',
endpoint: '<string>',
method: 'POST',
description: '<string>',
payload: {},
timezone: 'UTC',
timeout_seconds: 3600,
max_retries: 0,
retry_delay_seconds: 60
})
};
fetch('https://api.example.com/schedules', 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/schedules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'cron_expr' => '<string>',
'endpoint' => '<string>',
'method' => 'POST',
'description' => '<string>',
'payload' => [
],
'timezone' => 'UTC',
'timeout_seconds' => 3600,
'max_retries' => 0,
'retry_delay_seconds' => 60
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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/schedules"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"cron_expr\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"method\": \"POST\",\n \"description\": \"<string>\",\n \"payload\": {},\n \"timezone\": \"UTC\",\n \"timeout_seconds\": 3600,\n \"max_retries\": 0,\n \"retry_delay_seconds\": 60\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.post("https://api.example.com/schedules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"cron_expr\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"method\": \"POST\",\n \"description\": \"<string>\",\n \"payload\": {},\n \"timezone\": \"UTC\",\n \"timeout_seconds\": 3600,\n \"max_retries\": 0,\n \"retry_delay_seconds\": 60\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/schedules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"cron_expr\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"method\": \"POST\",\n \"description\": \"<string>\",\n \"payload\": {},\n \"timezone\": \"UTC\",\n \"timeout_seconds\": 3600,\n \"max_retries\": 0,\n \"retry_delay_seconds\": 60\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"method": "<string>",
"endpoint": "<string>",
"cron_expr": "<string>",
"timezone": "<string>",
"timeout_seconds": 123,
"max_retries": 123,
"retry_delay_seconds": 123,
"enabled": true,
"description": "<string>",
"payload": {},
"next_run_at": 123,
"created_at": 123,
"updated_at": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Maximum string length:
255Maximum string length:
128Maximum string length:
512Maximum string length:
10Maximum string length:
1024Maximum string length:
64Required range:
1 <= x <= 86400Required range:
0 <= x <= 10Required range:
1 <= x <= 3600Response
Successful Response
Was this page helpful?
⌘I