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

relationships

Relationships

Type: boolean Default: true

extend

Extend

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extend_fk

Extend Fk

Type: array of string Default: []
No Additional Items

Each item of this array must be:

Type: string

extend_context

Extend Context

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

prefix

Prefix

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

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

Return value

AppEntry

Type: object
No Additional Properties

name Required

Name

Type: string

Must be at least 1 characters long

id Required

Id

Type: string

Must be at least 1 characters long

state Required

State

Type: enum (of string)

Must be one of:

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

upgrade_available Required

Upgrade Available

Type: boolean

latest_version Required

Latest Version

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

custom_app Required

Custom App

Type: boolean

migrated Required

Migrated

Type: boolean

human_version Required

Human Version

Type: string

Must be at least 1 characters long

version Required

Version

Type: string

Must be at least 1 characters long

metadata Required

Metadata

Type: object

active_workloads Required

AppActiveWorkloads

Type: object
No Additional Properties

containers Required

Containers

Type: integer

used_ports Required

Used Ports

Type: array of object
No Additional Items

Each item of this array must be:

UsedPorts

Type: object
No Additional Properties

container_port Required

Container Port

Type: integer

protocol Required

Protocol

Type: string

host_ports Required

Host Ports

Type: array of object
No Additional Items

Each item of this array must be:

HostPorts

Type: object
No Additional Properties

host_port Required

Host Port

Type: integer

host_ip Required

Host Ip

Type: string

container_details Required

Container Details

Type: array of object
No Additional Items

Each item of this array must be:

AppContainerDetails

Type: object
No Additional Properties

id Required

Id

Type: string

service_name Required

Service Name

Type: string

image Required

Image

Type: string

port_config Required

Port Config

Type: array of object
No Additional Items

Each item of this array must be:

UsedPorts

Type: object
No Additional Properties

container_port Required

Container Port

Type: integer

protocol Required

Protocol

Type: string

host_ports Required

Host Ports

Type: array
No Additional Items

Each item of this array must be:

Type: object

state Required

State

Type: enum (of string)

Must be one of:

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

volume_mounts Required

Volume Mounts

Type: array of object
No Additional Items

Each item of this array must be:

AppVolumes

Type: object
No Additional Properties

source Required

Source

Type: string

destination Required

Destination

Type: string

mode Required

Mode

Type: string

type Required

Type

Type: string

volumes Required

Volumes

Type: array of object
No Additional Items

Each item of this array must be:

AppVolumes

Type: object
No Additional Properties

source Required

Source

Type: string

destination Required

Destination

Type: string

mode Required

Mode

Type: string

type Required

Type

Type: string

images Required

Images

Type: array of string
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
No Additional Items

Each item of this array must be:

AppNetworks

Type: object

Name Required

Name

Type: string

Id Required

Id

Type: string

Labels Required

Labels

Type: object

Additional Properties

Additional Properties of any type are allowed.

Type: object

notes Required

Notes

Any of

• Option 1
• Option 2

Type: string

Type: null

portals Required

Portals

Type: object

version_details

Version Details

Default: null

Any of

• Option 1
• Option 2

Type: object

Type: null

config

Config

Default: null

Any of

• Option 1
• Option 2

Type: object

Type: null

Required roles: APPS_READ