# 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: []
No Additional Items

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

Type: object

##### Parameter 2: options

#### options

Type: object
Default:
{ "relationships": true, "extend": null, "extend_context": null, "prefix": null, "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }
No Additional Properties

##

#### Relationships

Type: boolean Default: true

##

#### Extend

Default: null

## Any of

Type: string
Type: null

##

#### Extend Context

Default: null

## Any of

Type: string
Type: null

##

#### Prefix

Default: null

## Any of

Type: string
Type: null

##

#### Extra

Type: object Default: {}

##

#### Order By

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

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

Type: string

##

#### Select

Type: array Default: []
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

##

#### Count

Type: boolean Default: false

##

#### Get

Type: boolean Default: false

##

#### Offset

Type: integer Default: 0

##

#### Limit

Type: integer Default: 0

##

#### Force Sql Filters

Type: boolean Default: false

##

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

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

## Any of

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

## Any of

Type: string
Type: null

##

#### Portals

Type: object

##

#### Version Details

## Any of

Type: object
Type: null

##

#### Config

## Any of

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

## Any of

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

## Any of

Type: string
Type: null

##

#### Portals

Type: object

##

#### Version Details

## Any of

Type: object
Type: null

##

#### Config

## Any of

Type: object
Type: null
Type: integer

Required roles: APPS_READ