PUT
/
jobs
/
status
/
cancel
curl -X PUT "https://api.ionq.co/v0.3/jobs/status/cancel" \
  -H "Authorization: apiKey your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
        "ids": [
            "617a1f8b-59d4-435d-aa33-695433d7155e",
            "2ccf2773-4c28-468e-a290-2f8554808a25",
            "f92df2b6-d212-4f4a-b9ea-024b58c5c3e8"
        ]
    }'

{
  "ids": [
    "aa54e783-0a9b-4f73-ad2f-63983b6aa4a8"
  ],
  "status": "canceled"
}

Authorizations

​
Authorization
string
header
required

API keys are associated with a user and can be created on the IonQ Quantum Cloud application. To authenticate, prefix your API Key with apiKey and place it in the Authorization request header. Ex: Authorization: apiKey your-api-key

Body

application/json
​
ids
string[]

A list of job UUIDs to cancel.

The UUID of a job. We'll provide the UUID initially in our response to a job creation request.

Response

200 - application/json
Successfully cancelled requested jobs

Response body from successfully cancelling many jobs.

​
ids
string[]
required

A list of UUIDs of cancelled jobs.

The UUID of a job. We'll provide the UUID initially in our response to a job creation request.

​
status
enum<string>
required

Status of a job (always canceled).

Available options:
canceled

Was this page helpful?