BizKitHub
DocsAPI ReferenceCron Run/api/v1/cron-run/{id}/finish
postCron RunPublic API v1

/api/v1/cron-run/{id}/finish

Closes the run (late: false). No further log entries are accepted. null in optional fields means "not set". A run that already timed out still accepts ONE finish: the response is 200 with late: true, status: "timeout" (the run stays a timeout), lateStatus and lateFinishDate; the late result is shown on the run in the admin and a follow-up CRN_RUN_LATE entry tells whether the job eventually succeeded. A run finished with status: "error" writes an error entry to the organisation log. Counts into the cron monitor quota of the API key (10,000 requests per hour, separate from other endpoints). Every response carries X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (Unix seconds).

cron-runpostApiV1Cron-runByIdFinish

Parameters

1 path · JSON body

Path parameters

· 1
idstringRequired

Run id returned by /cron-run/start.

Length: 16–16
ExampleaB3dE5fG7hJ9kL1m

Request body

application/json
status"success" | "error" | nullOptional
One of 2:
Variant 1
"success" | "error"

Outcome of the run. Defaults to success.

Variant 2
null
messagestring | nullOptional
One of 2:
Variant 1
string

Final message, e.g. the error text. null = none.

Length: 0–20000
Variant 2
null
reportobject | nullOptional
One of 2:
Variant 1
object

Summary of the run, e.g. { "processed": 120 }, up to 16 KB. null = none.

Variant 2
null
exitCodestring | integer | nullOptional
One of 2:
Variant 1
string | integer
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
Range: -32768–32767
Variant 2
null
peakMemoryMbstring | integer | nullOptional
One of 2:
Variant 1
string | integer
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
Range: 0–∞
Variant 2
null
heapUsedMbstring | integer | nullOptional
One of 2:
Variant 1
string | integer
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
Range: 0–∞
Variant 2
null

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json
{
  "success": true
}

Request example

POST /api/v1/cron-run/{id}/finish

post
curl -X POST "https://api.bizkithub.com/api/v1/cron-run/aB3dE5fG7hJ9kL1m/finish" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key