Update Scheduler

Replaces the configuration of an existing scheduler.

Authentication

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

Path Parameters

Parameter Type Description
id string The unique identifier of the scheduler

Request Body

1{
2  "display_name": "renamed-scheduler"
3}

Example Request

1curl -X PUT "https://api.hola.cloud/schedulers/sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
2  -H "X-API-Key: YOUR_API_KEY" \
3  -H "Content-Type: application/json" \
4  -d '{
5    "display_name": "renamed-scheduler"
6  }'

Example Response

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

Error Codes

Status Code Description
400 invalid_json Invalid JSON payload
400 validation_error Invalid request body
401 unauthorized Missing or invalid API key
404 not_found Scheduler not found
500 internal_error Internal server error

Comments

Leave a comment