Table Of Contents

Previous topic

app.pull_images

Next topic

app.redeploy

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

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


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

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: