# 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.

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:
{ "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

Query options including pagination, ordering, and additional parameters.

No Additional Properties

##

#### 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:

## Any of

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

Force use of SQL for result filtering to reduce response time. May not work for all methods.

##

#### Result

## Any of

Type: array of object
No Additional Items

##### Each item of this array must be:

#### AppQueryResultItem

Type: object
No Additional Properties

##

#### Name

Type: string

The display name of the application.

Must be at least `1` characters long

##

#### Id

Type: string

Unique identifier for the application instance.

Must be at least `1` characters long

##

#### State

Type: enum (of string)

Current operational state of the application.

##### Must be one of:

- "CRASHED"
- "DEPLOYING"
- "RUNNING"
- "STOPPED"
- "STOPPING"

##

#### Upgrade Available

Type: boolean

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

##

#### Latest Version

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

## Any of

Type: string

Must be at least `1` characters long

Type: null

##

#### Image Updates Available

Type: boolean

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

##

#### Custom App

Type: boolean

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

##

#### Migrated

Type: boolean

Whether this application has been migrated from kubernetes.

##

#### Human Version

Type: string

Human-readable version string for display purposes.

Must be at least `1` characters long

##

#### Version

Type: string

Technical version identifier of the currently installed application.

Must be at least `1` characters long

##

#### Metadata

Type: object

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

##

#### AppActiveWorkloads

Type: object

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

No Additional Properties

##

#### Containers

Type: integer

Total number of containers currently running for this application.

##

#### 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

Type: integer

The port number inside the container.

##

#### Protocol

Type: string

The network protocol used.

Examples:

    "tcp"

    "udp"

##

#### 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

Type: integer

The port number on the host system.

##

#### Host Ip

Type: string

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

##

#### 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

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

Type: string

Unique identifier for the container.

##

#### Service Name

Type: string

Name of the service this container provides.

##

#### Image

Type: string

Docker image name and tag used by this container.

##

#### 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

Type: integer

The port number inside the container.

##

#### Protocol

Type: string

The network protocol used.

Examples:

    "tcp"

    "udp"

##

#### 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

Type: enum (of string)

Current state of the container.

##### Must be one of:

- "crashed"
- "created"
- "exited"
- "running"
- "starting"

##

#### 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

Type: string

The source path or volume name on the host system.

##

#### Destination

Type: string

The mount path inside the container.

##

#### Mode

Type: string

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

##

#### Type

Type: string

The volume type.

Examples:

    "bind"

    "volume"

##

#### 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

Type: string

The source path or volume name on the host system.

##

#### Destination

Type: string

The mount path inside the container.

##

#### Mode

Type: string

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

##

#### Type

Type: string

The volume type.

Examples:

    "bind"

    "volume"

##

#### 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

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

Type: string

The name of the Docker network.

##

#### Id

Type: string

Unique identifier for the Docker network.

##

#### Labels

Type: object

Key-value pairs of labels associated with the network.

##

Additional Properties of any type are allowed.

Type: object

##

#### Notes

User-provided notes or comments about this application instance.

## Any of

Type: string
Type: null

##

#### Portals

Type: object

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

##

#### Version Details

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

## Any of

Type: object
Type: null

##

#### Config

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

## Any of

Type: object
Type: null

#### AppQueryResultItem

Type: object
No Additional Properties

##

#### Name

Type: string

The display name of the application.

Must be at least `1` characters long

##

#### Id

Type: string

Unique identifier for the application instance.

Must be at least `1` characters long

##

#### State

Type: enum (of string)

Current operational state of the application.

##### Must be one of:

- "CRASHED"
- "DEPLOYING"
- "RUNNING"
- "STOPPED"
- "STOPPING"

##

#### Upgrade Available

Type: boolean

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

##

#### Latest Version

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

## Any of

Type: string

Must be at least `1` characters long

Type: null

##

#### Image Updates Available

Type: boolean

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

##

#### Custom App

Type: boolean

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

##

#### Migrated

Type: boolean

Whether this application has been migrated from kubernetes.

##

#### Human Version

Type: string

Human-readable version string for display purposes.

Must be at least `1` characters long

##

#### Version

Type: string

Technical version identifier of the currently installed application.

Must be at least `1` characters long

##

#### Metadata

Type: object

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

##

Type: object

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

##

#### Notes

User-provided notes or comments about this application instance.

## Any of

Type: string
Type: null

##

#### Portals

Type: object

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

##

#### Version Details

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

## Any of

Type: object
Type: null

##

#### Config

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

## Any of

Type: object
Type: null
Type: integer

Required roles: APPS_READ