D-Wave Regions API

The Regions API from D-Wave — 2 operation(s) for regions.

OpenAPI Specification

d-wave-regions-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: D-Wave Leap Hybrid Solvers Account Regions API
  version: '3.0'
  description: 'Leap Hybrid Solvers — quantum-classical hybrid samplers (BQM, CQM, DQM, NL) submitted

    via the standard SAPI Problems endpoint with `type=bqm|cqm|dqm|nl` and the matching

    hybrid solver name. This spec narrows the generic SAPI submit surface to the hybrid

    solver request/response shapes.

    '
  contact:
    name: D-Wave Quantum Inc.
    url: https://docs.dwavequantum.com/en/industrial_optimization/index_get_started.html
servers:
- url: https://cloud.dwavesys.com/sapi/v2
security:
- SapiToken: []
tags:
- name: Regions
paths:
  /regions/:
    get:
      operationId: listRegions
      summary: List Regions
      description: Enumerate Leap regions and their SAPI base URLs.
      tags:
      - Regions
      responses:
        '200':
          description: Region list
          content:
            application/vnd.dwave.metadata.regions+json;version=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Region'
  /regions/{code}:
    get:
      operationId: getRegion
      summary: Get Region
      tags:
      - Regions
      parameters:
      - in: path
        name: code
        required: true
        schema:
          type: string
        example: na-west-1
      responses:
        '200':
          description: Region details
          content:
            application/vnd.dwave.metadata.region+json;version=1.0:
              schema:
                $ref: '#/components/schemas/Region'
components:
  schemas:
    Region:
      type: object
      required:
      - code
      - endpoint
      properties:
        code:
          type: string
          example: na-west-1
        name:
          type: string
          example: North America (West)
        endpoint:
          type: string
          format: uri
          example: https://na-west-1.cloud.dwavesys.com/sapi/v2
        description:
          type: string
  securitySchemes:
    SapiToken:
      type: apiKey
      in: header
      name: X-Auth-Token