app.query¶
Query all apps with query-filters and query-options.
The following query-options.extra options are supported:
host_ip(str):Override the portal IP address when it is a wildcard.
include_app_schema(bool):Include the app schema in the response.
retrieve_config(bool):Include the app configuration used to install or manage the app.
Type: object
No Additional Properties
Type: array
No Additional Items
No Additional Items
No Additional Properties
No Additional Items
No Additional Items
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: objectDefault:
{
"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: trueExtend
Default: null
Type: string
Type: null
Extend Context
Default: null
Type: string
Type: null
Prefix
Default: null
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:
Type: string
Type: array
No Additional Items
No Additional Items
Each item of this array must be:
Type: object
Count
Type: boolean Default: falseGet
Type: boolean Default: falseOffset
Type: integer Default: 0Value must be greater or equal to 0
Limit
Type: integer Default: 0Value must be greater or equal to 0 and lesser or equal to 10000
Force Sql Filters
Type: boolean Default: falseResult
Type: array of object
No Additional Items
No Additional Properties
No Additional Properties
No Additional Items
No Additional Properties
No Additional Items
No Additional Properties
No Additional Items
No Additional Properties
No Additional Items
No Additional Properties
No Additional Items
No Additional Items
No Additional Properties
No Additional Items
No Additional Properties
No Additional Items
No Additional Items
No Additional Items
Each item of this array must be:
AppEntry
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
Type: string
Must be at least 1 characters long
Type: null
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: objectAppActiveWorkloads
Type: objectNo Additional Properties
Containers
Type: integerUsed Ports
Type: array of objectNo Additional Items
Each item of this array must be:
UsedPorts
Type: objectNo Additional Properties
Container Port
Type: integerProtocol
Type: stringHost Ports
Type: array of objectNo Additional Items
Each item of this array must be:
HostPorts
Type: objectNo Additional Properties
Host Port
Type: integerHost Ip
Type: stringContainer Details
Type: array of objectNo Additional Items
Each item of this array must be:
AppContainerDetails
Type: objectNo Additional Properties
Id
Type: stringService Name
Type: stringImage
Type: stringPort Config
Type: array of objectNo Additional Items
Each item of this array must be:
UsedPorts
Type: objectNo Additional Properties
Container Port
Type: integerProtocol
Type: stringHost Ports
Type: arrayNo 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 objectNo Additional Items
Each item of this array must be:
AppVolumes
Type: objectNo Additional Properties
Source
Type: stringDestination
Type: stringMode
Type: stringType
Type: stringVolumes
Type: array of objectNo Additional Items
Each item of this array must be:
AppVolumes
Type: objectNo Additional Properties
Source
Type: stringDestination
Type: stringMode
Type: stringType
Type: stringImages
Type: array of stringNo Additional Items
Each item of this array must be:
Type: string
Must be at least 1 characters long
Networks
Type: array of objectNo Additional Items
Each item of this array must be:
AppNetworks
Type: objectName
Type: stringId
Type: stringLabels
Type: objectAdditional Properties of any type are allowed.
Type: objectNotes
Type: string
Must be at most 2147483647 characters long
Type: null
Portals
Type: objectVersion Details
Default: null
Type: object
Type: null
Config
Default: null
Type: object
Type: null
AppEntry
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
Type: string
Must be at least 1 characters long
Type: null
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: object
Type: object
Notes
Type: string
Must be at most 2147483647 characters long
Type: null
Portals
Type: objectVersion Details
Default: null
Type: object
Type: null
Config
Default: null
Type: object
Type: null
Type: array of object
No Additional Items
No Additional Items
Each item of this array must be:
Type: object
Type: object
Type: integer
Required roles: APPS_READ