container.get_instance

Returns instance matching id. If id is not found, Validation error is raised.

Please see query method documentation for options.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

Parameter 2: options

options

Type: object Default: {}

Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.

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

ContainerEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

Container ID.

uuid

Uuid

Default: null

Container UUID (for libvirt).

Any of

• Option 1
• Option 2

Type: string

Type: null

name Required

Name

Type: string

Container name.

Must be at least 1 characters long

description

Description

Type: string Default: ""

Container description.

devices

Devices

Type: array of object Default: []

Container's devices.

No Additional Items

Each item of this array must be:

ContainerDeviceEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

Unique identifier for the containers device.

attributes Required

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 Required

Container

Type: integer

ID of the container this device belongs to.

cpuset

Cpuset

Default: null

List of physical CPU numbers that domain process and virtual CPUs can be pinned to by default.

Any of

• Option 1
• Option 2

Type: string

Type: null

autostart

Autostart

Type: boolean Default: true

Automatically start the container on boot.

time

Time

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

Whether container time should be local time or UTC time.

Must be one of:

• "LOCAL"
• "UTC"

shutdown_timeout

Shutdown Timeout

Type: integer Default: 90

How many seconds to wait for container to shut down before killing it.

Value must be greater or equal to 5 and lesser or equal to 300

dataset Required

Dataset

Type: string

Which dataset to use as the container root filesystem.

init

Init

Type: string Default: "/sbin/init"

"init" process commandline.

initdir

Initdir

Default: null

"init" process working dir.

Any of

• Option 1
• Option 2

Type: string

Type: null

initenv

Initenv

Type: object Default: {}

"init" process environment variables.

Additional Properties

Each additional property must conform to the following schema

Type: string

inituser

Inituser

Default: null

"init" process username.

Any of

• Option 1
• Option 2

Type: string

Type: null

initgroup

Initgroup

Default: null

"init" process group.

Any of

• Option 1
• Option 2

Type: string

Type: null

idmap

Idmap

Default: {"type": "DEFAULT"}

Idmap configuration for the container There are three two possible values: DEFAULT: This applies the standard TrueNAS idmap namespace configuration. It changes user ID (UID) 0 (root) in the container to UID 2147000001 (truenascontainerunpriv_root). It offsets the other container UIDs by the same amount. For example, UID 1000 in the container becomes UID 2147001001 in the host. ISOLATED: Same as DEFAULT, but UID will be calculated as 2147000001 + 65536 * slice. This will ensure unique ID for each container (provided that the slice is also unique).
None: The container does not apply any idmap namespace. Container UIDs map directly to host UIDs. For example, UID 0 in the container is UID 0 in the host. WARNING: For security, use the DEFAULT value. Security best practice is to run containers with idmap namespaces.

Any of

• Option 1
• Option 2

One of

• DefaultIdmapConfiguration
• IsolatedIdmapConfiguration

DefaultIdmapConfiguration

Type: object
No Additional Properties

type Required

Type

Type: const

Configuration type for default ID mapping.

Specific value: "DEFAULT"

IsolatedIdmapConfiguration

Type: object
No Additional Properties

type Required

Type

Type: const

Configuration type for isolated ID mapping.

Specific value: "ISOLATED"

slice Required

Slice

null when creating means we'll look up an unused slice on backend.

Any of

• Option 1
• Option 2

Type: integer

Value must be strictly greater than 0 and strictly lesser than 1000

Type: null

Type: null

capabilities_policy

Capabilities Policy

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

Default rules for capabilities: either keep the default behavior that is dropping the following capabilities: sysmodule, systime, mknod, auditcontrol, macadmin. Or keep all capabilities, or drop all capabilities.

Must be one of:

• "DEFAULT"
• "ALLOW"
• "DENY"

capabilities_state

Capabilities State

Type: object Default: {}

Enable or disable specific capabilities.

Additional Properties

Each additional property must conform to the following schema

Type: boolean

status Required

ContainerStatus

Type: object

Container state.

No Additional Properties

state Required

State

Type: enum (of string)

Container state.

Must be one of:

• "RUNNING"
• "STOPPED"

pid Required

Pid

Container PID (if running).

Any of

• Option 1
• Option 2

Type: integer

Type: null

domain_state Required

Domain State

Domain state reported by libvirt.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

Required roles: CONTAINER_READ