Sign in
jobs

Cancel a job

Cancels a running or pending job by JID. Publishes a cancel request to the target sprout over NATS. RBAC scope checking ensures the caller has job_admin permission for the job's sprout.

delete/api/v1/jobs/{jid}

Path parameters

jidstring required

Job identifier

Response

Job cancel request published

{"stackTrail":"components:schemas:NATSEnvelope:properties:result","oasType":"schema","type":"unknown","description":"Response data (structure varies by endpoint — see endpoint examples)"}
errorstring

Error message (present only on failure)

Changes

Changed in 3 of the 10 revisions of this API.342

  • 011f9b67b17a12See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ○

      added the optional property error to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property result to the response with the 200 status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1aab0676c2b412See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • ●

      removed the optional property error from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property result from the response with the 200 status

      response-optional-property-removed

    This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 26871a2f667f12See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • ●

      removed the optional property error from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property result from the response with the 200 status

      response-optional-property-removed

    This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog