/api/service/scheduler/heartbeat

Liveness signal from the external scheduler runner. Stored as a temp record so /api/v1/ping/health can flag the runner offline if no heartbeat is received within the staleness window.

servicepostApiServiceSchedulerHeartbeat

Parameters

JSON body

Request body

application/json

apiKeystringRequired

runnerIdstringRequired

Length: 4–8

requestCountnumberRequired

Range: 0–∞

successCountnumberRequired

Range: 0–∞

Response schema

1 status code documented

200Success

success"true"Required

Response example

application/json

{
  "success": true
}

Request example

POST /api/service/scheduler/heartbeat

post

curl -X POST "https://api.bizkithub.com/api/service/scheduler/heartbeat" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "apiKey": "example_apiKey",
  "runnerId": "example_runnerId",
  "requestCount": 0,
  "successCount": 0
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key