Instances

Get instances

Get user instances

HTTP Response Status Codes

Status code	Description
200	Get user instances
401	Unauthorized
500	Internal server error

Code samples

GET

/instances

curl -X GET \
  https://api.quantum-computing.ibm.com/runtime/instances \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Accept: application/json'

import requests
 
response = requests.request(
    "GET",
    "https://api.quantum-computing.ibm.com/runtime/instances",
    headers={
        "Accept": "application/json",
        "Authorization": "Bearer YOUR_API_TOKEN_HERE"
    },
)
print(response.json())

Responses

Status code

{
  "instances": [
    {
      "name": "ibm-q/open/main",
      "plan": "premium"
    }
  ]
}

Status code

{
  "type": "object",
  "properties": {
    "instances": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "ibm-q/open/main"
          },
          "plan": {
            "type": "string",
            "enum": [
              "premium",
              "open",
              "internal"
            ]
          }
        },
        "required": [
          "name",
          "plan"
        ]
      }
    }
  },
  "required": [
    "instances"
  ]
}

Was this page helpful?

Report a bug or request content on GitHub.