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.
No Additional Items
Tuple Validation
Parameter 1: filters
filters
Type: array Default: []No Additional Items
Each item of this array must be:
Parameter 2: options
options
Type: objectNo Additional Properties
Relationships
Type: boolean Default: trueExtend
Default: nullExtend Context
Default: nullPrefix
Default: nullExtra
Type: object Default: {}Order By
Type: array of string Default: []No Additional Items
Each item of this array must be:
Select
Type: array Default: []No Additional Items
Each item of this array must be:
No Additional Items
Each item of this array must be:
Count
Type: boolean Default: falseGet
Type: boolean Default: falseOffset
Type: integer Default: 0Limit
Type: integer Default: 0Force Sql Filters
Type: boolean Default: falseResult
No Additional Items
Each item of this array must be:
AppQueryResultItem
Type: objectNo Additional Properties
Name
Type: stringMust be at least 1
characters long
Id
Type: stringMust be at least 1
characters long
State
Type: enum (of string)Must be one of:
- "CRASHED"
- "DEPLOYING"
- "RUNNING"
- "STOPPED"
- "STOPPING"
Upgrade Available
Type: booleanLatest Version
Must be at least 1
characters long
Image Updates Available
Type: booleanCustom App
Type: booleanMigrated
Type: booleanHuman Version
Type: stringMust be at least 1
characters long
Version
Type: stringMust be at least 1
characters long
Metadata
Type: objectNotes
Portals
Type: objectVersion Details
Config
AppQueryResultItem
Type: objectNo Additional Properties
Name
Type: stringMust be at least 1
characters long
Id
Type: stringMust be at least 1
characters long
State
Type: enum (of string)Must be one of:
- "CRASHED"
- "DEPLOYING"
- "RUNNING"
- "STOPPED"
- "STOPPING"
Upgrade Available
Type: booleanLatest Version
Must be at least 1
characters long
Image Updates Available
Type: booleanCustom App
Type: booleanMigrated
Type: booleanHuman Version
Type: stringMust be at least 1
characters long
Version
Type: stringMust be at least 1
characters long
Metadata
Type: objectNotes
Portals
Type: objectVersion Details
Config
Required roles: APPS_READ