app.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: string

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

AppEntry

Type: object
No Additional Properties

name Required

Name

Type: string

The display name of the application.

Must be at least 1 characters long

id Required

Id

Type: string

Unique identifier for the application instance.

Must be at least 1 characters long

state Required

State

Type: enum (of string)

Current operational state of the application.

Must be one of:

• "CRASHED"
• "DEPLOYING"
• "RUNNING"
• "STOPPED"
• "STOPPING"

upgrade_available Required

Upgrade Available

Type: boolean

Whether a newer version of the application is available for upgrade.

latest_version Required

Latest Version

The latest available version string, or null if no updates are available.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

image_updates_available Required

Image Updates Available

Type: boolean

Whether newer Docker images are available for the containers in this application.

custom_app Required

Custom App

Type: boolean

Whether this is a custom application (true) or from a catalog (false).

migrated Required

Migrated

Type: boolean

Whether this application has been migrated from kubernetes.

human_version Required

Human Version

Type: string

Human-readable version string for display purposes.

Must be at least 1 characters long

version Required

Version

Type: string

Technical version identifier of the currently installed application.

Must be at least 1 characters long

metadata Required

Metadata

Type: object

Application metadata including description, category, and other catalog information.

active_workloads Required

AppActiveWorkloads

Type: object

Information about the running containers, ports, and resources used by this application.

No Additional Properties

containers Required

Containers

Type: integer

Total number of containers currently running for this application.

used_ports Required

Used Ports

Type: array of object

Array of all port mappings used by the application.

No Additional Items

Each item of this array must be:

UsedPorts

Type: object
No Additional Properties

container_port Required

Container Port

Type: integer

The port number inside the container.

protocol Required

Protocol

Type: string

The network protocol used.

Examples:

"tcp"

"udp"

host_ports Required

Host Ports

Type: array of object

Array of host port mappings for this container port.

No Additional Items

Each item of this array must be:

HostPorts

Type: object
No Additional Properties

host_port Required

Host Port

Type: integer

The port number on the host system.

host_ip Required

Host Ip

Type: string

The IP address on the host system that the port is bound to.

used_host_ips Required

Used Host Ips

Type: array of string

Array of host IP addresses in use by the application.

No Additional Items

Each item of this array must be:

Type: string

container_details Required

Container Details

Type: array of object

Detailed information about each container in the application.

No Additional Items

Each item of this array must be:

AppContainerDetails

Type: object
No Additional Properties

id Required

Id

Type: string

Unique identifier for the container.

service_name Required

Service Name

Type: string

Name of the service this container provides.

image Required

Image

Type: string

Docker image name and tag used by this container.

port_config Required

Port Config

Type: array of object

Array of port mappings for this container.

No Additional Items

Each item of this array must be:

UsedPorts

Type: object
No Additional Properties

container_port Required

Container Port

Type: integer

The port number inside the container.

protocol Required

Protocol

Type: string

The network protocol used.

Examples:

"tcp"

"udp"

host_ports Required

Host Ports

Type: array

Array of host port mappings for this container port.

No Additional Items

Each item of this array must be:

Type: object

state Required

State

Type: enum (of string)

Current state of the container.

Must be one of:

• "crashed"
• "created"
• "exited"
• "running"
• "starting"

volume_mounts Required

Volume Mounts

Type: array of object

Array of volume mounts configured for this container.

No Additional Items

Each item of this array must be:

AppVolumes

Type: object
No Additional Properties

source Required

Source

Type: string

The source path or volume name on the host system.

destination Required

Destination

Type: string

The mount path inside the container.

mode Required

Mode

Type: string

The mount mode (e.g., 'rw' for read-write, 'ro' for read-only).

type Required

Type

Type: string

The volume type.

Examples:

"bind"

"volume"

volumes Required

Volumes

Type: array of object

Array of all volume mounts used by the application.

No Additional Items

Each item of this array must be:

AppVolumes

Type: object
No Additional Properties

source Required

Source

Type: string

The source path or volume name on the host system.

destination Required

Destination

Type: string

The mount path inside the container.

mode Required

Mode

Type: string

The mount mode (e.g., 'rw' for read-write, 'ro' for read-only).

type Required

Type

Type: string

The volume type.

Examples:

"bind"

"volume"

images Required

Images

Type: array of string

Array of Docker image names used by the application.

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

networks Required

Networks

Type: array of object

Array of Docker networks associated with the application.

No Additional Items

Each item of this array must be:

AppNetworks

Type: object

Name Required

Name

Type: string

The name of the Docker network.

Id Required

Id

Type: string

Unique identifier for the Docker network.

Labels Required

Labels

Type: object

Key-value pairs of labels associated with the network.

Additional Properties

Additional Properties of any type are allowed.

Type: object

notes Required

Notes

User-provided notes or comments about this application instance.

Any of

• Option 1
• Option 2

Type: string

Type: null

portals Required

Portals

Type: object

Web portals and access points provided by the application (URLs, ports, etc.).

version_details

Version Details

Default: null

Detailed version information including changelog and upgrade notes. null if not available.

Any of

• Option 1
• Option 2

Type: object

Type: null

config

Config

Default: null

Current configuration values for the application. null if configuration is not requested.

Any of

• Option 1
• Option 2

Type: object

Type: null

Required roles: APPS_READ