Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ibm-quantum Backends API

The Backends API from ibm-quantum — 5 operation(s) for backends.

ibm-quantum Backends API is one of 11 APIs that ibm-quantum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Backends. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.

This API exposes 5 operations across 5 paths, and defines 19 schemas. It is described by OpenAPI 3.0.0, at version 0.45.3.

Requests are made against 2 base URLs: https://quantum.cloud.ibm.com/api, https://eu-de.quantum.cloud.ibm.com/api.

5 operations 5 paths 19 schemas 5 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.45.3
Servers
https://quantum.cloud.ibm.com/api
https://eu-de.quantum.cloud.ibm.com/api
Authentication
HTTP Bearer, API Key, API Key
License
Resource Areas
1

Authentication & Security 3

ibm-quantum Backends API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). An API key is passed in the header as Service-CRN (ServiceCRN). An API key is passed in the header as IBM-API-Version (ApiVersion). By default, every request must be authenticated.

  • BearerAuth — IBM Cloud IAM bearer token
  • ServiceCRN — IBM Cloud Service CRN identifying the Qiskit Runtime instance
  • ApiVersion — API version, e.g. 2026-03-15

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 GET. Each is listed below with its method, path, parameters, and response codes.

Backends 5
GET
/v1/backends
List Your Backends
list_backends 2 params → 200
GET
/v1/backends/{id}/properties
Get Backend Properties
get_backend_properties 4 params → 200
GET
/v1/backends/{id}/configuration
Get Backend Configuration
get_backend_configuration 3 params → 200
GET
/v1/backends/{id}/status
Get Backend Status
get_backend_status 2 params → 200
GET
/v1/backends/{id}/defaults
Get Backend Default Settings
get_backend_defaults 2 params → 200

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are BackendConfigurationResponse (49 properties), GateConfig (7 properties), BackendPropertiesResponse (6 properties), BackendStatusResponse (5 properties). Each schema is shown below with its type and property counts.

ClopsType
object
2 properties 2 required
TwoQErrorBest
object
4 properties 3 required
BackendDefaultsResponse
object
Backends Defaults Response
ReadoutErrorMedian
object
2 properties 1 required
BackendsResponse
object
Backends Response
1 property 1 required
GateProperties
object
3 properties 3 required
ProcessorType
object
The processor type of this backend
3 properties 2 required
Hamiltonian
object
Hamiltonian of the backend
4 properties 1 required
BackendStatusResponse
object
Backends Status Response
5 properties 1 required
BackendPropertiesNduv
object
4 properties 4 required
TimingConstraints
object
The timing constraints on this backend
4 properties
TwoQErrorMedian
object
2 properties 1 required
BackendPropertiesResponse
object
6 properties 6 required
BackendConfigurationResponse
object
Backends Configuration Response
49 properties 12 required
TwoQErrorLayered
object
2 properties 1 required
GateConfig
object
The definition of a gate
7 properties 3 required
PerformanceMetrics
object
4 properties
UChannelLOItem
object
The description of a single U Channel LO in terms of qubit LO's
2 properties 2 required
ComplexNumber
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ibm-quantum-backends-api-openapi.yml Raw ↑

Other APIs ibm-quantum publishes across the network.

Qiskit Functions Catalog API
Qiskit Transpiler as a Service API
ibm-quantum Accounts API
ibm-quantum Analytics API
ibm-quantum Instances API
ibm-quantum Jobs API
ibm-quantum Sessions API
ibm-quantum Tags API
ibm-quantum Versions API
ibm-quantum Workloads API