Skip to content
Pasqal Documentation

Get Public Devices

GET
/api/v1/devices

Return the list of all devices for a non-authenticated user.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
order_by
Order By
string
default: created_at
order_by_direction
string
Allowed values: ASC DESC
limit
Limit
integer
default: 100 > 0 < 101
offset
Offset
integer
0
device_type

Filter devices by type. Omit to skip filter.

Array<string>
default:
Allowed values: EMU_FREE EMU_SV EMU_TN EMU_C FRESNEL FRESNEL_CAN1 EMU_FRESNEL FRESNEL_RD EMU_MPS

Filter devices by type. Omit to skip filter.

availability

Filter devices by availability status. Omit to skip filter.

Array<string>
default:
Allowed values: ACTIVE INACTIVE RETIRED

Filter devices by availability status. Omit to skip filter.

public
Public

Filter devices by public visibility. Omit to skip filter.

boolean
""

Filter devices by public visibility. Omit to skip filter.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

HeaderPaginatedResponse[ProducedDeviceResponse]

A list of responses with pagination information.

For backwards compatibility, this also exposes pagination using the following header format:

Access-Control-Expose-Headers: Content-Range
Content-Range: $FIRST_ITEM_IN_BATCH-$LAST_ITEM_IN_BACH/$TOTAL_ITEMS_AVAILABLE
object
status
string
Allowed values: success fail error
message
Message
string
default: OK.
code
Code
string
default: 200
data
required
Data
Array<object>
ProducedDeviceResponse

Response to a request for device to display on a page.

object
id
required
Id
string format: uuid
name
required
Name
string
device_type
required
Device Type
string
status
required
DeviceStatus

An enumeration.

string
Allowed values: UP DOWN
average_queue_time
required
Average Queue Time
integer
max_atom_num
Max Atom Num
integer
is_emulator
required
Is Emulator
boolean
channels
Channels
Array<string>
status_message
Status Message
string
allowed_result_types
required
Array<string>
Allowed values: counter run sample expectation
default_result_types
required
Array<string>
Allowed values: counter run sample expectation
active
required
Active
boolean
description
Description
string
bill_usage
required
Bill Usage
boolean
availability
required
DeviceAvailability

An enumeration.

string
Allowed values: ACTIVE INACTIVE RETIRED
has_execution_logs
required
Has Execution Logs
boolean
pagination
required
JSendPagination

Pagination information

object
total
required
Total
integer
start
required
Start
integer
end
required
End
integer

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string