Create Scheduler

Creates a new scheduler.

Authentication

Requires authentication. Pass your API key via X-API-Key or Authorization: Bearer header.

Request Body

1{
2  "id": "sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
3  "display_name": "my-scheduler"
4}

Example Request

curl -X POST "https://api.hola.cloud/schedulers" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "display_name": "my-scheduler"
  }'
POST /schedulers HTTP/1.1
Host: api.hola.cloud
X-API-Key: YOUR_API_KEY
Content-Type: application/json

{
    "id": "sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "display_name": "my-scheduler"
  }
package main

import (
	"fmt"
	"io"
	"net/http"
	"encoding/json"
	"strings"
)

func main() {
	payload := map[string]any{"display_name": "my-scheduler", "id": "sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890"}
	bodyBytes, err := json.Marshal(payload)
	if err != nil {
		panic(err)
	}
	body := string(bodyBytes)

	req, err := http.NewRequest("POST", "https://api.hola.cloud/schedulers", strings.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-API-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	responseBody, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(responseBody))
}
<?php
$payload = ['display_name' => 'my-scheduler', 'id' => 'sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890'];
$body = json_encode($payload);

$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.hola.cloud/schedulers',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => $body,
    CURLOPT_HTTPHEADER => [
        'X-API-Key: YOUR_API_KEY',
        'Content-Type: application/json',
    ],
]);

$response = curl_exec($ch);
if ($response === false) {
    throw new Exception(curl_error($ch));
}
curl_close($ch);

echo $response;
import requests

import json

headers = {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json",
}

payload = {"display_name": "my-scheduler", "id": "sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890"}
body = json.dumps(payload)

response = requests.request(
    "POST",
    "https://api.hola.cloud/schedulers",
    headers=headers,
    data=body
)

print(response.text)
const payload = {"display_name": "my-scheduler", "id": "sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890"};

const response = await fetch("https://api.hola.cloud/schedulers", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify(payload)
});

console.log(await response.text());
const payload = {"display_name": "my-scheduler", "id": "sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890"};

const response = await fetch("https://api.hola.cloud/schedulers", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify(payload)
});

const text = await response.text();
console.log(text);
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
import java.util.List;

public class Main {
    public static void main(String[] args) throws Exception {
        var payload = Map.of("display_name", "my-scheduler", "id", "sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890");
        var body = new ObjectMapper().writeValueAsString(payload);

        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.hola.cloud/schedulers"))
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .header("X-API-Key", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Example Response

1HTTP/1.1 201 Created
2Content-Type: application/json
 1{
 2  "scheduler": {
 3    "id": "sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
 4    "ready": true,
 5    "scheduled": 0,
 6    "inflight": 0,
 7    "display_name": "my-scheduler",
 8    "created_at": "2025-06-21T10:00:00Z",
 9    "updated_at": "2025-06-21T10:00:00Z"
10  }
11}

Error Codes

Status Code Description
400 invalid_json Invalid JSON payload
400 validation_error Missing or invalid id, display_name, or description
401 unauthorized Missing or invalid API key
409 conflict Scheduler already exists
500 internal_error Internal server error

Comments

Leave a comment