List of filters for query results. See API documentation for "Query Methods" for more guidance.
No Additional Items[
[
"name",
"=",
"bob"
]
]
[
[
"OR",
[
[
[
"name",
"=",
"bob"
]
],
[
[
"name",
"=",
"larry"
]
]
]
]
]
Query options including pagination, ordering, and additional parameters.
No Additional PropertiesExtra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.
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).
[
"size",
"-devname",
"nulls_first:-expiretime"
]
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.
[
"username",
"Authentication.status"
]
Return a numeric value representing the number of items that match the specified query-filters.
Return the JSON object of the first result matching the specified query-filters. The query fails if there specified query-filters return no results.
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.
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 use of SQL for result filtering to reduce response time. May not work for all methods.
Unique identifier for the virtual instance.
Human-readable name for the virtual instance.
Must be at least 1 characters long
Must be at most 200 characters long
Type of virtual instance.
Current operational status of the virtual instance.
CPU configuration string or null for default allocation.
Memory allocation in bytes or null for default allocation.
Whether the instance automatically starts when the host boots.
Environment variables to set inside the instance.
Each additional property must conform to the following schema
Type: stringArray of IP aliases configured for the instance.
No Additional ItemsType of IP address (INET for IPv4, INET6 for IPv6).
IP address for the virtual instance.
Must be at least 1 characters long
Network mask in CIDR notation.
Image information used to create this instance.
No Additional PropertiesHardware architecture of the image (e.g., amd64, arm64).
Human-readable description of the image.
Operating system family of the image.
Version or release name of the operating system.
Unique serial identifier for the image.
Type of image (container, virtual-machine, etc.).
Image variant (default, cloud, minimal, etc.).
Whether the image supports UEFI Secure Boot.
User namespace ID mapping configuration for privilege isolation.
User ID mapping configuration for user namespace isolation.
Starting host ID for the mapping range.
Number of IDs to map in this range.
Starting namespace ID for the mapping range.
Group ID mapping configuration for user namespace isolation.
Starting host ID for the mapping range.
Number of IDs to map in this range.
Starting namespace ID for the mapping range.
Raw low-level configuration options (advanced use only).
Whether VNC remote access is enabled for the instance.
TCP port number for VNC connections or null if VNC is disabled.
Password for VNC access or null if no password is set.
Must be at least 1 characters long
Whether UEFI Secure Boot is enabled (VMs only) or null for containers.
Whether the container runs in privileged mode or null for VMs.
Size of the root disk in GB or null for default size.
I/O bus type for the root disk or null for default.
Storage pool in which the root of the instance is located.
Must be at least 1 characters long
Unique identifier for the virtual instance.
Human-readable name for the virtual instance.
Must be at least 1 characters long
Must be at most 200 characters long
Type of virtual instance.
Current operational status of the virtual instance.
CPU configuration string or null for default allocation.
Memory allocation in bytes or null for default allocation.
Whether the instance automatically starts when the host boots.
Environment variables to set inside the instance.
Each additional property must conform to the following schema
Type: stringArray of IP aliases configured for the instance.
No Additional ItemsImage information used to create this instance.
User namespace ID mapping configuration for privilege isolation.
Raw low-level configuration options (advanced use only).
Whether VNC remote access is enabled for the instance.
TCP port number for VNC connections or null if VNC is disabled.
Password for VNC access or null if no password is set.
Must be at least 1 characters long
Whether UEFI Secure Boot is enabled (VMs only) or null for containers.
Whether the container runs in privileged mode or null for VMs.
Size of the root disk in GB or null for default size.
I/O bus type for the root disk or null for default.
Storage pool in which the root of the instance is located.
Must be at least 1 characters long