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

Call parameters

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

Relationships

Type: boolean Default: true

extend

Extend

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extend_context

Extend Context

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

prefix

Prefix

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extra

Extra

Type: object Default: {}

order_by

Order By

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

Each item of this array must be:

Type: string

select

Select

Type: array Default: []
No Additional Items

Each item of this array must be:

Any of

• Option 1
• Option 2

Type: string

Type: array
No Additional Items

Each item of this array must be:

Type: object

count

Count

Type: boolean Default: false

get

Get

Type: boolean Default: false

offset

Offset

Type: integer Default: 0

limit

Limit

Type: integer Default: 0

force_sql_filters

Force Sql Filters

Type: boolean Default: false

Return value

Result

Any of

• Option 1
• AppQueryResultItem
• Option 3

Type: array of object
No Additional Items

Each item of this array must be:

AppQueryResultItem

Type: object
No Additional Properties

name

Name

Type: string

Must be at least 1 characters long

id

Id

Type: string

Must be at least 1 characters long

state

State

Type: enum (of string)

Must be one of:

• "CRASHED"
• "DEPLOYING"
• "RUNNING"
• "STOPPED"
• "STOPPING"

upgrade_available

Upgrade Available

Type: boolean

latest_version

Latest Version

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

image_updates_available

Image Updates Available

Type: boolean

custom_app

Custom App

Type: boolean

migrated

Migrated

Type: boolean

human_version

Human Version

Type: string

Must be at least 1 characters long

version

Version

Type: string

Must be at least 1 characters long

metadata

Metadata

Type: object

active_workloads

AppActiveWorkloads

Type: object
No Additional Properties

containers Required

Containers

Type: integer

used_ports Required

Used Ports

Type: array of object
No Additional Items

Each item of this array must be:

UsedPorts

Type: object
No Additional Properties

container_port Required

Container Port

Type: integer

protocol Required

Protocol

Type: string

host_ports Required

Host Ports

Type: array of object
No Additional Items

Each item of this array must be:

HostPorts

Type: object
No Additional Properties

host_port Required

Host Port

Type: integer

host_ip Required

Host Ip

Type: string

container_details Required

Container Details

Type: array of object
No Additional Items

Each item of this array must be:

AppContainerDetails

Type: object
No Additional Properties

id Required

Id

Type: string

service_name Required

Service Name

Type: string

image Required

Image

Type: string

port_config Required

Port Config

Type: array of object
No Additional Items

Each item of this array must be:

UsedPorts

Type: object
No Additional Properties

container_port Required

Container Port

Type: integer

protocol Required

Protocol

Type: string

host_ports Required

Host Ports

Type: array
No Additional Items

Each item of this array must be:

Type: object

state Required

State

Type: enum (of string)

Must be one of:

• "crashed"
• "created"
• "exited"
• "running"
• "starting"

volume_mounts Required

Volume Mounts

Type: array of object
No Additional Items

Each item of this array must be:

AppVolumes

Type: object
No Additional Properties

source Required

Source

Type: string

destination Required

Destination

Type: string

mode Required

Mode

Type: string

type Required

Type

Type: string

volumes Required

Volumes

Type: array of object
No Additional Items

Each item of this array must be:

AppVolumes

Type: object
No Additional Properties

source Required

Source

Type: string

destination Required

Destination

Type: string

mode Required

Mode

Type: string

type Required

Type

Type: string

images Required

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 Required

Networks

Type: array of object
No Additional Items

Each item of this array must be:

AppNetworks

Type: object

Name Required

Name

Type: string

Id Required

Id

Type: string

Labels Required

Labels

Type: object

Additional Properties

Additional Properties of any type are allowed.

Type: object

notes

Notes

Any of

• Option 1
• Option 2

Type: string

Type: null

portals

Portals

Type: object

version_details

Version Details

Any of

• Option 1
• Option 2

Type: object

Type: null

config

Config

Any of

• Option 1
• Option 2

Type: object

Type: null

AppQueryResultItem

Type: object
No Additional Properties

name

Name

Type: string

Must be at least 1 characters long

id

Id

Type: string

Must be at least 1 characters long

state

State

Type: enum (of string)

Must be one of:

• "CRASHED"
• "DEPLOYING"
• "RUNNING"
• "STOPPED"
• "STOPPING"

upgrade_available

Upgrade Available

Type: boolean

latest_version

Latest Version

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

image_updates_available

Image Updates Available

Type: boolean

custom_app

Custom App

Type: boolean

migrated

Migrated

Type: boolean

human_version

Human Version

Type: string

Must be at least 1 characters long

version

Version

Type: string

Must be at least 1 characters long

metadata

Metadata

Type: object

active_workloads

Type: object

notes

Notes

Any of

• Option 1
• Option 2

Type: string

Type: null

portals

Portals

Type: object

version_details

Version Details

Any of

• Option 1
• Option 2

Type: object

Type: null

config

Config

Any of

• Option 1
• Option 2

Type: object

Type: null

Type: integer

Required roles: APPS_READ