QBqbraid
Jobs

Cancel a job

Changed on

Request cancellation of a job. Cancellation is asynchronous (HTTP 202).

post/jobs/{job_qrn}/cancel

Request

  • Base URL
    https://api-v2.qbraid.com/api/v1
  • URL
    https://api-v2.qbraid.com/api/v1/jobs/{job_qrn}/cancel
  • Auth
    API key in header X-API-KEY

Path parameters

job_qrnstring required
Example:aws:aws:sim:dm1-a1b2-qjob-1234567890abcdef

The job qrn (qBraid Resource Name).

Response

Cancellation initiated.

successboolean required

Example response

{
  "success": true,
  "data": {
    "message": "Job cancellation initiated successfully"
  }
}

Changes

  • 20848d926124Revision changes
    • breaking

      for the path request parameter job_qrn, the minLength was increased from 0 to 1

    • warning

      removed the optional property from the response with the status

    • warning

      added the new CANCELLED enum value to the / response property for the response status

    • warning

      added the new CANCELLING enum value to the / response property for the response status

    • warning

      added the new COMPLETED enum value to the / response property for the response status

    • warning

      added the new FAILED enum value to the / response property for the response status

    • warning

      added the new HOLD enum value to the / response property for the response status

    • warning

      added the new INITIALIZING enum value to the / response property for the response status

    • warning

      added the new QUEUED enum value to the / response property for the response status

    • warning

      added the new RUNNING enum value to the / response property for the response status

    • warning

      added the new UNKNOWN enum value to the / response property for the response status

    • warning

      added the new VALIDATING enum value to the / response property for the response status

    • info

      api operation id cancel_job_jobs__job_qrn__cancel_post removed and replaced with cancelJob

    • info

      api tag Jobs added

    • info

      api tag jobs removed

    • info

      removed the non-success response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status