virt.instance.query

Query all instances with query-filters and query-options.

Type: object

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

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

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

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:

Type: string
Type: array
No Additional Items
Each item of this array must be:
Type: object

Example:

[
    "username",
    "Authentication.status"
]

Count

Type: boolean Default: false

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

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

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

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

Type: boolean Default: false

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

Result


Type: array of object
No Additional Items
Each item of this array must be:

VirtInstanceQueryResultItem

Type: object
No Additional Properties

Id

Type: string

Unique identifier for the virtual instance.

Name

Type: string

Human-readable name for the virtual instance.

Must be at least 1 characters long

Must be at most 200 characters long

Type

Type: enum (of string)

Type of virtual instance.

Must be one of:
  • "CONTAINER"
  • "VM"

Status

Type: enum (of string)

Current operational status of the virtual instance.

Must be one of:
  • "RUNNING"
  • "STOPPED"
  • "UNKNOWN"
  • "ERROR"
  • "FROZEN"
  • "STARTING"
  • "STOPPING"
  • "FREEZING"
  • "THAWED"
  • "ABORTING"

Cpu


CPU configuration string or null for default allocation.

Type: string
Type: null

Memory


Memory allocation in bytes or null for default allocation.

Type: integer
Type: null

Autostart

Type: boolean

Whether the instance automatically starts when the host boots.

Environment

Type: object

Environment variables to set inside the instance.

Each additional property must conform to the following schema

Type: string

Aliases

Type: array of object

Array of IP aliases configured for the instance.

 No Additional Items
Each item of this array must be:

VirtInstanceAlias

Type: object
No Additional Properties

Type

Type: enum (of string)

Type of IP address (INET for IPv4, INET6 for IPv6).

Must be one of:
  • "INET"
  • "INET6"

Address

Type: string

IP address for the virtual instance.

Must be at least 1 characters long

Netmask


Network mask in CIDR notation.

Type: integer
Type: null

Image

Type: object

Image information used to create this instance.

 No Additional Properties

Architecture


Hardware architecture of the image (e.g., amd64, arm64).

Type: string
Type: null

Description


Human-readable description of the image.

Type: string
Type: null

Os


Operating system family of the image.

Type: string
Type: null

Release


Version or release name of the operating system.

Type: string
Type: null

Serial


Unique serial identifier for the image.

Type: string
Type: null

Type


Type of image (container, virtual-machine, etc.).

Type: string
Type: null

Variant


Image variant (default, cloud, minimal, etc.).

Type: string
Type: null

Secureboot


Whether the image supports UEFI Secure Boot.

Type: boolean
Type: null


User namespace ID mapping configuration for privilege isolation.

UserNsIdmap

Type: object
No Additional Properties


User ID mapping configuration for user namespace isolation.

IdmapUserNsEntry

Type: object
No Additional Properties

Hostid

Type: integer

Starting host ID for the mapping range.

Maprange

Type: integer

Number of IDs to map in this range.

Nsid

Type: integer

Starting namespace ID for the mapping range.
Type: null


Group ID mapping configuration for user namespace isolation.

IdmapUserNsEntry

Type: object
No Additional Properties

Hostid

Type: integer

Starting host ID for the mapping range.

Maprange

Type: integer

Number of IDs to map in this range.

Nsid

Type: integer

Starting namespace ID for the mapping range.
Type: null
Type: null

Raw


Raw low-level configuration options (advanced use only).

Type: object
Type: null

Vnc Enabled

Type: boolean

Whether VNC remote access is enabled for the instance.

Vnc Port


TCP port number for VNC connections or null if VNC is disabled.

Type: integer
Type: null

Vnc Password


Password for VNC access or null if no password is set.

Type: string

Must be at least 1 characters long

Type: null

Secure Boot


Whether UEFI Secure Boot is enabled (VMs only) or null for containers.

Type: boolean
Type: null

Privileged Mode


Whether the container runs in privileged mode or null for VMs.

Type: boolean
Type: null

Root Disk Size


Size of the root disk in GB or null for default size.

Type: integer
Type: null

Root Disk Io Bus

Type: enum (of null or string)

I/O bus type for the root disk or null for default.

Must be one of:
  • "NVME"
  • "VIRTIO-BLK"
  • "VIRTIO-SCSI"
  • null

Storage Pool

Type: string

Storage pool in which the root of the instance is located.

Must be at least 1 characters long

VirtInstanceQueryResultItem

Type: object
No Additional Properties

Id

Type: string

Unique identifier for the virtual instance.

Name

Type: string

Human-readable name for the virtual instance.

Must be at least 1 characters long

Must be at most 200 characters long

Type

Type: enum (of string)

Type of virtual instance.

Must be one of:
  • "CONTAINER"
  • "VM"

Status

Type: enum (of string)

Current operational status of the virtual instance.

Must be one of:
  • "RUNNING"
  • "STOPPED"
  • "UNKNOWN"
  • "ERROR"
  • "FROZEN"
  • "STARTING"
  • "STOPPING"
  • "FREEZING"
  • "THAWED"
  • "ABORTING"

Cpu


CPU configuration string or null for default allocation.

Type: string
Type: null

Memory


Memory allocation in bytes or null for default allocation.

Type: integer
Type: null

Autostart

Type: boolean

Whether the instance automatically starts when the host boots.

Environment

Type: object

Environment variables to set inside the instance.

Each additional property must conform to the following schema

Type: string

Aliases

Type: array

Array of IP aliases configured for the instance.

 No Additional Items
Each item of this array must be:
Type: object

Type: object

Image information used to create this instance.


User namespace ID mapping configuration for privilege isolation.

Type: object
Type: null

Raw


Raw low-level configuration options (advanced use only).

Type: object
Type: null

Vnc Enabled

Type: boolean

Whether VNC remote access is enabled for the instance.

Vnc Port


TCP port number for VNC connections or null if VNC is disabled.

Type: integer
Type: null

Vnc Password


Password for VNC access or null if no password is set.

Type: string

Must be at least 1 characters long

Type: null

Secure Boot


Whether UEFI Secure Boot is enabled (VMs only) or null for containers.

Type: boolean
Type: null

Privileged Mode


Whether the container runs in privileged mode or null for VMs.

Type: boolean
Type: null

Root Disk Size


Size of the root disk in GB or null for default size.

Type: integer
Type: null

Root Disk Io Bus

Type: enum (of null or string)

I/O bus type for the root disk or null for default.

Must be one of:
  • "NVME"
  • "VIRTIO-BLK"
  • "VIRTIO-SCSI"
  • null

Storage Pool

Type: string

Storage pool in which the root of the instance is located.

Must be at least 1 characters long

Type: integer


Required roles: VIRT_INSTANCE_READ