QBqbraid
Jobs

Cancel a job group

Changed on

Cancel a group and all of its non-terminal child jobs. A CLOSED group can still be cancelled.

post/jobs/group/{group_qrn}/cancel

Request

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

Path parameters

group_qrnstring required
Example:group:a1b2-664f0c1e2a3b4c5d6e7f8090

The group qrn (qBraid Resource Name).

Response

Success.

successboolean required

Example response

{
  "success": true,
  "data": {
    "groupJobQrn": "group:a1b2-664f0c1e2a3b4c5d6e7f8090"
  }
}

Changes