Sign in
Jobs

🛡️ Control a job.

Control a job by updating its status. Pausing will only kick in between the next job tasks, resuming is instant.<br /><hr /><h3>🛡️ Requires Capabilities: <code>Jobs.Operate</code></h3>

patch/api/v1/job/{id}

Path parameters

idnumber required

Request body

status'draft' | 'preparing' | 'in_queue' | 'running' | 'paused' | 'canceled' | 'completed' | 'errored'
completedAtstring date-time

Response

jobIdstring required
type'album_art_thumbnails' | 'photo_variations' | 'photo_thumbnails' | 'generate_waveforms' required
status'draft' | 'preparing' | 'in_queue' | 'running' | 'paused' | 'canceled' | 'completed' | 'errored' required
parametersobject
completedTasksnumber required
remainingTasksnumber required
totalTasksnumber required
completedAtstring date-time required
errorMessagestring required
idnumber required
createdAtstring date-time required
updatedAtstring date-time required
deletedAtstring date-time required

Changes

Changed in 2 of the 176 revisions of this API.21

  • ae7d637d180311See the full diff
    • ●

      added the new generate_waveforms enum value to the type response property for the response status 200

      response-property-enum-value-added

    • ○

      removed the generate_waveform enum value from the type response property for the response status 200

      response-property-enum-value-removed

  • 404b6308c09a1See the full diff
    • ●

      added the new generate_waveform enum value to the type response property for the response status 200

      response-property-enum-value-added