DocsAPI ReferenceService/api/service/scheduler/peek
postServiceService

/api/service/scheduler/peek

Read-only peek into the scheduler queue. Runs the same SELECT used by /claim but without the UPDATE, so the runner can validate end-to-end queue access (auth + DB + query) from its health check without consuming jobs.

servicepostApiServiceSchedulerPeek

Parameters

2 body

2 total
Body · 2
apiKeystringRequired
sampleSizenumber
Range: 025

Request

POST /api/service/scheduler/peek

post
curl -X POST "https://api.bizkithub.com/api/service/scheduler/peek" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "apiKey": "example_apiKey",
  "sampleSize": 0
}'

Response

JSON payload

{
  "success": true
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key