Close an OPEN group so it accepts no new jobs; existing jobs continue running.

POST/jobs/group/{group_qrn}/close

Authorizations

X-API-KEYstringheaderrequired

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

group_qrnstringrequired

The group qrn (qBraid Resource Name).

Response

200Success.
successbooleanrequired
dataobjectrequired
404Group not found.
409Group is already in a terminal status.
Close a job group
curl --request POST \
  --url https://api-v2.qbraid.com/api/v1/jobs/group/{group_qrn}/close \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api-v2.qbraid.com/api/v1/jobs/group/{group_qrn}/close"
headers = {
    "X-API-KEY": "<api-key>"
}

response = requests.post(url, headers=headers)
print(response.json())
const url = "https://api-v2.qbraid.com/api/v1/jobs/group/{group_qrn}/close";
const options = {
  method: "POST",
  headers: {"X-API-KEY":"<api-key>"},
};

const response = await fetch(url, options);
console.log(await response.json());
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-v2.qbraid.com/api/v1/jobs/group/{group_qrn}/close",
  CURLOPT_RETURNTRANSFER => true,
  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"
	"io"
	"net/http"
)

func main() {
	url := "https://api-v2.qbraid.com/api/v1/jobs/group/{group_qrn}/close"

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

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

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))
}
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api-v2.qbraid.com/api/v1/jobs/group/{group_qrn}/close"))
    .header("X-API-KEY", "<api-key>")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
require 'uri'
require 'net/http'

url = URI("https://api-v2.qbraid.com/api/v1/jobs/group/{group_qrn}/close")

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
{
  "success": true,
  "data": {
    "_id": "<string>",
    "groupJobQrn": "group:a1b2-664f0c1e2a3b4c5d6e7f8090",
    "name": "<string>",
    "status": "OPEN",
    "organizationUserId": "<string>",
    "jobCount": 123,
    "completedCount": 123,
    "failedCount": 123,
    "cancelledCount": 123,
    "totalEstimatedCost": 123,
    "totalCost": 123,
    "maxTTL": 123,
    "timeStamps": {
      "createdAt": "2024-01-01T00:00:00Z",
      "endedAt": "2024-01-01T00:00:00Z",
      "executionDuration": 123
    },
    "tags": {},
    "metadata": {}
  }
}
{
  "success": false,
  "message": "<string>",
  "error": {
    "message": "<string>",
    "code": "<string>"
  }
}
{
  "success": false,
  "message": "<string>",
  "error": {
    "message": "<string>",
    "code": "<string>"
  }
}