app.query ========= Query all apps with `query-filters` and `query-options`. `query-options.extra.host_ip` is a string which can be provided to override portal IP address if it is a wildcard. `query-options.extra.include_app_schema` is a boolean which can be set to include app schema in the response. `query-options.extra.retrieve_config` is a boolean which can be set to retrieve app configuration used to install/manage app. .. raw:: html
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:
{ "relationships": true, "extend": null, "extend_fk": [], "extend_context": null, "prefix": null, "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

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

Type: boolean Default: true

Extend

Default: null

Type: string
Type: null

Extend Fk

Type: array of string Default: []
No Additional Items
Each item of this array must be:
Type: string

Extend Context

Default: null

Type: string
Type: null

Prefix

Default: null

Type: string
Type: null

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

Result


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

AppQueryResultItem

Type: object
No Additional Properties

Name

Type: string

Must be at least 1 characters long

Id

Type: string

Must be at least 1 characters long

State

Type: enum (of string)
Must be one of:
  • "CRASHED"
  • "DEPLOYING"
  • "RUNNING"
  • "STOPPED"
  • "STOPPING"

Upgrade Available

Type: boolean

Latest Version


Type: string

Must be at least 1 characters long

Type: null

Image Updates Available

Type: boolean

Custom App

Type: boolean

Migrated

Type: boolean

Human Version

Type: string

Must be at least 1 characters long

Version

Type: string

Must be at least 1 characters long

Metadata

Type: object

AppActiveWorkloads

Type: object
No Additional Properties

Containers

Type: integer

Used Ports

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

UsedPorts

Type: object
No Additional Properties

Container Port

Type: integer

Protocol

Type: string

Host Ports

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

HostPorts

Type: object
No Additional Properties

Host Port

Type: integer

Host Ip

Type: string

Container Details

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

AppContainerDetails

Type: object
No Additional Properties

Id

Type: string

Service Name

Type: string

Image

Type: string

Port Config

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

UsedPorts

Type: object
No Additional Properties

Container Port

Type: integer

Protocol

Type: string

Host Ports

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

State

Type: enum (of string)
Must be one of:
  • "crashed"
  • "created"
  • "exited"
  • "running"
  • "starting"

Volume Mounts

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

AppVolumes

Type: object
No Additional Properties

Source

Type: string

Destination

Type: string

Mode

Type: string

Type

Type: string

Volumes

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

AppVolumes

Type: object
No Additional Properties

Source

Type: string

Destination

Type: string

Mode

Type: string

Type

Type: string

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

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

AppNetworks

Type: object

Name

Type: string

Id

Type: string

Labels

Type: object

Additional Properties of any type are allowed.

Type: object

Notes


Type: string
Type: null

Portals

Type: object

Version Details


Type: object
Type: null

Config


Type: object
Type: null

AppQueryResultItem

Type: object
No Additional Properties

Name

Type: string

Must be at least 1 characters long

Id

Type: string

Must be at least 1 characters long

State

Type: enum (of string)
Must be one of:
  • "CRASHED"
  • "DEPLOYING"
  • "RUNNING"
  • "STOPPED"
  • "STOPPING"

Upgrade Available

Type: boolean

Latest Version


Type: string

Must be at least 1 characters long

Type: null

Image Updates Available

Type: boolean

Custom App

Type: boolean

Migrated

Type: boolean

Human Version

Type: string

Must be at least 1 characters long

Version

Type: string

Must be at least 1 characters long

Metadata

Type: object

Type: object

Notes


Type: string
Type: null

Portals

Type: object

Version Details


Type: object
Type: null

Config


Type: object
Type: null
Type: integer


*Required roles:* APPS_READ