Sign in
latestOpenAPI 3.1.02026-08-04394216477.7 KB

fd3a41a6260b

admin-maintenance

Cancel Maintenance Job

Request cancellation of a queued or running job. The worker checks the row's status between batches and exits cleanly.

post/api/v1/admin/maintenance/jobs/{job_id}/cancel

Path parameters

job_idinteger required

Headers

authorizationstring nullable
X-API-Keystring nullable

Response

Successful Response

idinteger required
tenant_idinteger required
job_typestring required
object_typesstring[] required
scopeobject required
optionsobject required
statusstring required
total_stepsinteger required
processed_stepsinteger required
current_phasestring nullable required
phase_progressobject required
error_messagestring nullable required
started_atstring date-time nullable required
completed_atstring date-time nullable required
created_byinteger nullable required
created_atstring date-time required
updated_atstring date-time nullable required