container.device.query

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: filters

filters

Type: array Default: []

List of filters for query results. See API documentation for "Query Methods" for more guidance.

No Additional Items

Each item of this array must be:

Type: object

Examples:

[
    [
        "name",
        "=",
        "bob"
    ]
]

[
    [
        "OR",
        [
            [
                [
                    "name",
                    "=",
                    "bob"
                ]
            ],
            [
                [
                    "name",
                    "=",
                    "larry"
                ]
            ]
        ]
    ]
]

Parameter 2: options

options

Type: object

Default:

{ "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

Query options including pagination, ordering, and additional parameters.

No Additional Properties

extra

Extra

Type: object Default: {}

Extra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.

order_by

Order By

Type: array of string Default: []

An array of field names describing the manner in which query results should be ordered. The field names may also have one of more of the following special prefixes: - (reverse sort direction), nulls_first: (place any null values at the head of the results list), nulls_last: (place any null values at the tail of the results list).

No Additional Items

Each item of this array must be:

Type: string

Example:

[
    "size",
    "-devname",
    "nulls_first:-expiretime"
]

select

Select

Type: array Default: []

An array of field names specifying the exact fields to include in the query return. The dot character . may be used to explicitly select only subkeys of the query result.

No Additional Items

Each item of this array must be:

Any of

• Option 1
• Option 2

Type: string

Type: array
No Additional Items

Each item of this array must be:

Type: object

Example:

[
    "username",
    "Authentication.status"
]

count

Count

Type: boolean Default: false

Return a numeric value representing the number of items that match the specified query-filters.

get

Get

Type: boolean Default: false

Return the JSON object of the first result matching the specified query-filters. The query fails if there specified query-filters return no results.

offset

Offset

Type: integer Default: 0

This specifies the beginning offset of the results array. When combined with the limit query-option it may be used to implement pagination of large results arrays. WARNING: some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

limit

Limit

Type: integer Default: 0

This specifies the maximum number of results matching the specified query-filters to return. When combined wtih the offset query-option it may be used to implement pagination of large results arrays.

WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

force_sql_filters

Force Sql Filters

Type: boolean Default: false

Force use of SQL for result filtering to reduce response time. May not work for all methods.

Return value

Result

Any of

• Option 1
• ContainerDeviceQueryResultItem
• Option 3

Type: array of object
No Additional Items

Each item of this array must be:

ContainerDeviceQueryResultItem

Type: object
No Additional Properties

id

Id

Type: integer

Unique identifier for the containers device.

attributes

Attributes

Device-specific configuration attributes.

One of

• ContainerFilesystemDevice
• ContainerGPUDevice
• ContainerNICDevice
• ContainerUSBDevice

ContainerFilesystemDevice

Type: object
No Additional Properties

dtype Required

Dtype

Type: const

Device type identifier for FILESYSTEM devices.

Specific value: "FILESYSTEM"

target

Target

Type: string Default: "/usr/bin/zsh"

Target must not contain braces.

Must match regular expression: ^[^{}]*$

Must be at least 1 characters long

source

Source

Type: string Default: "/usr/bin/zsh"

Source must not contain braces, and not start with /mnt/.

Must match regular expression: ^[^{}]*$

Must be at least 1 characters long

ContainerGPUDevice

Type: object
No Additional Properties

dtype Required

Dtype

Type: const

Device type identifier for GPU devices.

Specific value: "GPU"

gpu_type Required

Gpu Type

Type: const

GPU device type.

Specific value: "AMD"

pci_address Required

Pci Address

Type: string

PCI address of the GPU device on the host system.

Must be at least 1 characters long

ContainerNICDevice

Type: object
No Additional Properties

dtype Required

Dtype

Type: const

Device type identifier for network interface cards.

Specific value: "NIC"

trust_guest_rx_filters

Trust Guest Rx Filters

Type: boolean Default: false

Whether to trust guest OS receive filter settings for better performance.

type

Type

Type: enum (of string) Default: "E1000"

Network interface controller type. E1000 for Intel compatibility, VIRTIO for performance.

Must be one of:

• "E1000"
• "VIRTIO"

nic_attach

Nic Attach

Default: null

Host network interface or bridge to attach to. null for no attachment.

Any of

• Option 1
• Option 2

Type: string

Type: null

mac

Mac

Default: null

MAC address for the virtual network interface. null for auto-generation.

Any of

• Option 1
• Option 2

Type: string
Must match regular expression: ^([0-9A-Fa-f]{2}[:-]?){5}([0-9A-Fa-f]{2})$

Type: null

ContainerUSBDevice

Type: object
No Additional Properties

dtype Required

Dtype

Type: const

Device type identifier for USB devices.

Specific value: "USB"

usb

Default: null

USB device attributes for identification. null for USB host controller only.

Any of

• USBAttributes
• Option 2

USBAttributes

Type: object
No Additional Properties

vendor_id

Vendor Id

Type: string Default: "/usr/bin/zsh"

USB vendor identifier in hexadecimal format (e.g., '0x1d6b' for Linux Foundation).

Must match regular expression: ^0x.*

Must be at least 1 characters long

product_id

Product Id

Type: string Default: "/usr/bin/zsh"

USB product identifier in hexadecimal format (e.g., '0x0002' for 2.0 root hub).

Must match regular expression: ^0x.*

Must be at least 1 characters long

Type: null

device

Device

Default: null

Host USB device path to pass through. null for controller only.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

container

Container

Type: integer

ID of the container this device belongs to.

ContainerDeviceQueryResultItem

Type: object
No Additional Properties

id

Id

Type: integer

Unique identifier for the containers device.

attributes

Attributes

Device-specific configuration attributes.

One of

• Option 1
• Option 2
• Option 3
• Option 4

Type: object

Type: object

Type: object

Type: object

container

Container

Type: integer

ID of the container this device belongs to.

Type: integer

Required roles: CONTAINER_DEVICE_READ