Cancel Job

Cancel a quantum job.

Args:

• job_qrn (string): Job QRN (qBraid Resource Name)

Returns:

• Object containing a confirmation message, the job QRN, and the updated status

Raises:

• 400: Job is in an invalid state for cancellation or vendor is not supported
• 404: Job is not found
• 422: Validation error if the job_qrn parameter is invalid

POST /jobs/{job_qrn}/cancel

Cancel Job

cURL

curl --request POST \
  --url https://api-v2.qbraid.com/api/v1/jobs/{job_qrn}/cancel \
  --header 'X-API-KEY: <api-key>'

import requests

url = "https://api-v2.qbraid.com/api/v1/jobs/{job_qrn}/cancel"

headers = {"X-API-KEY": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api-v2.qbraid.com/api/v1/jobs/{job_qrn}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-v2.qbraid.com/api/v1/jobs/{job_qrn}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-v2.qbraid.com/api/v1/jobs/{job_qrn}/cancel"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-v2.qbraid.com/api/v1/jobs/{job_qrn}/cancel")
  .header("X-API-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-v2.qbraid.com/api/v1/jobs/{job_qrn}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

202

{
  "success": true,
  "data": {
    "message": "Job cancellation initiated successfully",
    "jobQrn": "qbraid:job:abc123xyz",
    "status": "CANCELLING"
  }
}

202

{
  "success": true,
  "data": {
    "message": "Job cancellation initiated successfully",
    "jobQrn": "qbraid:job:abc123xyz",
    "status": "CANCELLING"
  }
}

Authorizations

X-API-KEY · string · header · required

Authenticate requests using an API key linked to your qBraid account. Obtain your key by registering or logging in at account.qbraid.com.

Path Parameters

job_qrn · string · required

Job QRN (qBraid Resource Name)

Response

202

application/json

Successful Response

Response schema for job cancellation

success · boolean · required

Whether the cancellation was initiated successfully

data · object · required

Show child attributes