Instances

Get instance configuration. Only available on IBM Cloud.

Returns the configuration for the specified instance e.g. instance limit in seconds, using CRN from context params of the request.

HTTP Response Status Codes

Status code	Description
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

Code samples

GET

/instances/configuration

curl -H "x-access-token: <YOUR-TOKEN>" \
  https://runtime-us-east.quantum-computing.ibm.com/instances/configuration

Responses

Status code

{
  "instance_limit": 123456
}

Status code

{
  "type": "object",
  "description": "Instance configuration",
  "properties": {
    "instance_limit": {
      "type": "number",
      "format": "double",
      "description": "Instance usage limit in seconds"
    }
  }
}

Update instance configuration. Only available on IBM Cloud.

Update the configuration for the specified instance e.g. instance limit in seconds, using CRN from context params of the request.

Body Parameters (application/json)

Name, Type	Description
instance_limit number	Instance usage limit in seconds
instance_limit integer	This field can be null or an integer. Use null to reset/remove the instance limit.

HTTP Response Status Codes

Status code	Description
204	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
409	Usage exceeds instance limit

Code samples

PUT

/instances/configuration

curl -X PUT -H "x-access-token: <YOUR-TOKEN>" \
  https://runtime-us-east.quantum-computing.ibm.com/instances/configuration

Responses

Status code

Get instance usage (all time usage). Only available on IBM Cloud.

Returns the usage value in seconds for the specified instance, using CRN from context params of the request.

HTTP Response Status Codes

Status code	Description
200	OK
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal error

Code samples

GET

/instances/usage

curl -H "x-access-token: <YOUR-TOKEN>" \
  https://runtime-us-east.quantum-computing.ibm.com/instances/usage

Responses

Status code

{
  "value": {
    "bss": {
      "seconds": 123
    },
    "usage": {
      "quantum_seconds": 123,
      "seconds": 123
    }
  }
}

Status code

{
  "type": "object",
  "description": "Instance usage metrics including total classical and quantum execution times.",
  "properties": {
    "bss": {
      "type": "object",
      "description": "Contains information about instance usage metrics",
      "properties": {
        "seconds": {
          "type": "integer",
          "description": "Total billed time for the instance - quantum seconds only."
        }
      },
      "required": [
        "seconds"
      ]
    },
    "usage": {
      "type": "object",
      "description": "Contains information about job usage metrics",
      "properties": {
        "quantum_seconds": {
          "type": "integer",
          "format": "int64",
          "description": "Total quantum seconds used by the instance"
        },
        "seconds": {
          "type": "integer",
          "description": "Total billed time for the instance - quantum seconds only."
        }
      }
    }
  },
  "required": [
    "bss"
  ]
}