# app.query

Sent on app changes.

Type: object

##

#### AppAddedEvent

Type: object
No Additional Properties

##

#### Id

Type: string

##

#### AppEntry

Type: object
No Additional Properties

##

#### Name

Type: string

The display name of the application.

Must be at least `1` characters long

##

#### Id

Type: string

Unique identifier for the application instance.

Must be at least `1` characters long

##

#### State

Type: enum (of string)

Current operational state of the application.

##### Must be one of:

- "CRASHED"
- "DEPLOYING"
- "RUNNING"
- "STOPPED"
- "STOPPING"

##

#### Upgrade Available

Type: boolean

Whether a newer version of the application is available for upgrade.

##

#### Latest Version

The latest available version string, or `null` if unable to determine latest version.

## Any of

Type: string

Must be at least `1` characters long

Type: null

##

#### Latest App Version

The latest application version string, or `null` if unable to determine latest version.

## Any of

Type: string

Must be at least `1` characters long

Type: null

##

#### Image Updates Available

Type: boolean

Whether newer Docker images are available for the containers in this application.

##

#### Custom App

Type: boolean

Whether this is a custom application (`true`) or from a catalog (`false`).

##

#### Migrated

Type: boolean

Whether this application has been migrated from kubernetes.

##

#### Human Version

Type: string

Human-readable version string for display purposes.

Must be at least `1` characters long

##

#### Version

Type: string

Technical version identifier of the currently installed application.

Must be at least `1` characters long

##

#### Metadata

Type: object

Application metadata including description, category, and other catalog information.

##

#### AppActiveWorkloads

Type: object

Information about the running containers, ports, and resources used by this application.

No Additional Properties

##

#### Containers

Type: integer

Total number of containers currently running for this application.

##

#### Used Ports

Type: array of object

Array of all port mappings used by the application.

No Additional Items

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

#### UsedPorts

Type: object
No Additional Properties

##

#### Container Port

Type: integer

The port number inside the container.

##

#### Protocol

Type: string

The network protocol used.

Examples:

    "tcp"

    "udp"

##

#### Host Ports

Type: array of object

Array of host port mappings for this container port.

No Additional Items

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

#### HostPorts

Type: object
No Additional Properties

##

#### Host Port

Type: integer

The port number on the host system.

##

#### Host Ip

Type: string

The IP address on the host system that the port is bound to.

##

#### Used Host Ips

Type: array of string

Array of host IP addresses in use by the application.

No Additional Items

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

Type: string

##

#### Container Details

Type: array of object

Detailed information about each container in the application.

No Additional Items

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

#### AppContainerDetails

Type: object
No Additional Properties

##

#### Id

Type: string

Unique identifier for the container.

##

#### Service Name

Type: string

Name of the service this container provides.

##

#### Image

Type: string

Docker image name and tag used by this container.

##

#### Port Config

Type: array of object

Array of port mappings for this container.

No Additional Items

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

#### UsedPorts

Type: object
No Additional Properties

##

#### Container Port

Type: integer

The port number inside the container.

##

#### Protocol

Type: string

The network protocol used.

Examples:

    "tcp"

    "udp"

##

#### Host Ports

Type: array

Array of host port mappings for this container port.

No Additional Items

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

Type: object

##

#### State

Type: enum (of string)

Current state of the container.

##### Must be one of:

- "crashed"
- "created"
- "exited"
- "running"
- "starting"

##

#### Volume Mounts

Type: array of object

Array of volume mounts configured for this container.

No Additional Items

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

#### AppVolumes

Type: object
No Additional Properties

##

#### Source

Type: string

The source path or volume name on the host system.

##

#### Destination

Type: string

The mount path inside the container.

##

#### Mode

Type: string

The mount mode (e.g., 'rw' for read-write, 'ro' for read-only).

##

#### Type

Type: string

The volume type.

Examples:

    "bind"

    "volume"

##

#### Volumes

Type: array of object

Array of all volume mounts used by the application.

No Additional Items

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

#### AppVolumes

Type: object
No Additional Properties

##

#### Source

Type: string

The source path or volume name on the host system.

##

#### Destination

Type: string

The mount path inside the container.

##

#### Mode

Type: string

The mount mode (e.g., 'rw' for read-write, 'ro' for read-only).

##

#### Type

Type: string

The volume type.

Examples:

    "bind"

    "volume"

##

#### Images

Type: array of string

Array of Docker image names used by the application.

No Additional Items

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

Type: string

Must be at least `1` characters long

##

#### Networks

Type: array of object

Array of Docker networks associated with the application.

No Additional Items

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

#### AppNetworks

Type: object

##

#### Name

Type: string

The name of the Docker network.

##

#### Id

Type: string

Unique identifier for the Docker network.

##

#### Labels

Type: object

Key-value pairs of labels associated with the network.

##

Additional Properties of any type are allowed.

Type: object

##

#### Notes

User-provided notes or comments about this application instance.

## Any of

Type: string
Type: null

##

#### Portals

Type: object

Web portals and access points provided by the application (URLs, ports, etc.).

##

#### Version Details

Default: null

Detailed version information including changelog and upgrade notes. `null` if not available.

## Any of

Type: object
Type: null

##

#### Config

Default: null

Current configuration values for the application. `null` if configuration is not requested.

## Any of

Type: object
Type: null

##

#### AppChangedEvent

Type: object
No Additional Properties

##

#### Id

Type: string

##

#### AppEntry

Type: object
No Additional Properties

##

#### Name

Type: string

The display name of the application.

Must be at least `1` characters long

##

#### Id

Type: string

Unique identifier for the application instance.

Must be at least `1` characters long

##

#### State

Type: enum (of string)

Current operational state of the application.

##### Must be one of:

- "CRASHED"
- "DEPLOYING"
- "RUNNING"
- "STOPPED"
- "STOPPING"

##

#### Upgrade Available

Type: boolean

Whether a newer version of the application is available for upgrade.

##

#### Latest Version

The latest available version string, or `null` if unable to determine latest version.

## Any of

Type: string

Must be at least `1` characters long

Type: null

##

#### Latest App Version

The latest application version string, or `null` if unable to determine latest version.

## Any of

Type: string

Must be at least `1` characters long

Type: null

##

#### Image Updates Available

Type: boolean

Whether newer Docker images are available for the containers in this application.

##

#### Custom App

Type: boolean

Whether this is a custom application (`true`) or from a catalog (`false`).

##

#### Migrated

Type: boolean

Whether this application has been migrated from kubernetes.

##

#### Human Version

Type: string

Human-readable version string for display purposes.

Must be at least `1` characters long

##

#### Version

Type: string

Technical version identifier of the currently installed application.

Must be at least `1` characters long

##

#### Metadata

Type: object

Application metadata including description, category, and other catalog information.

##

#### AppActiveWorkloads

Type: object

Information about the running containers, ports, and resources used by this application.

No Additional Properties

##

#### Containers

Type: integer

Total number of containers currently running for this application.

##

#### Used Ports

Type: array of object

Array of all port mappings used by the application.

No Additional Items

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

#### UsedPorts

Type: object
No Additional Properties

##

#### Container Port

Type: integer

The port number inside the container.

##

#### Protocol

Type: string

The network protocol used.

Examples:

    "tcp"

    "udp"

##

#### Host Ports

Type: array of object

Array of host port mappings for this container port.

No Additional Items

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

#### HostPorts

Type: object
No Additional Properties

##

#### Host Port

Type: integer

The port number on the host system.

##

#### Host Ip

Type: string

The IP address on the host system that the port is bound to.

##

#### Used Host Ips

Type: array of string

Array of host IP addresses in use by the application.

No Additional Items

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

Type: string

##

#### Container Details

Type: array of object

Detailed information about each container in the application.

No Additional Items

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

#### AppContainerDetails

Type: object
No Additional Properties

##

#### Id

Type: string

Unique identifier for the container.

##

#### Service Name

Type: string

Name of the service this container provides.

##

#### Image

Type: string

Docker image name and tag used by this container.

##

#### Port Config

Type: array of object

Array of port mappings for this container.

No Additional Items

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

#### UsedPorts

Type: object
No Additional Properties

##

#### Container Port

Type: integer

The port number inside the container.

##

#### Protocol

Type: string

The network protocol used.

Examples:

    "tcp"

    "udp"

##

#### Host Ports

Type: array

Array of host port mappings for this container port.

No Additional Items

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

Type: object

##

#### State

Type: enum (of string)

Current state of the container.

##### Must be one of:

- "crashed"
- "created"
- "exited"
- "running"
- "starting"

##

#### Volume Mounts

Type: array of object

Array of volume mounts configured for this container.

No Additional Items

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

#### AppVolumes

Type: object
No Additional Properties

##

#### Source

Type: string

The source path or volume name on the host system.

##

#### Destination

Type: string

The mount path inside the container.

##

#### Mode

Type: string

The mount mode (e.g., 'rw' for read-write, 'ro' for read-only).

##

#### Type

Type: string

The volume type.

Examples:

    "bind"

    "volume"

##

#### Volumes

Type: array of object

Array of all volume mounts used by the application.

No Additional Items

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

#### AppVolumes

Type: object
No Additional Properties

##

#### Source

Type: string

The source path or volume name on the host system.

##

#### Destination

Type: string

The mount path inside the container.

##

#### Mode

Type: string

The mount mode (e.g., 'rw' for read-write, 'ro' for read-only).

##

#### Type

Type: string

The volume type.

Examples:

    "bind"

    "volume"

##

#### Images

Type: array of string

Array of Docker image names used by the application.

No Additional Items

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

Type: string

Must be at least `1` characters long

##

#### Networks

Type: array of object

Array of Docker networks associated with the application.

No Additional Items

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

#### AppNetworks

Type: object

##

#### Name

Type: string

The name of the Docker network.

##

#### Id

Type: string

Unique identifier for the Docker network.

##

#### Labels

Type: object

Key-value pairs of labels associated with the network.

##

Additional Properties of any type are allowed.

Type: object

##

#### Notes

User-provided notes or comments about this application instance.

## Any of

Type: string
Type: null

##

#### Portals

Type: object

Web portals and access points provided by the application (URLs, ports, etc.).

##

#### Version Details

Default: null

Detailed version information including changelog and upgrade notes. `null` if not available.

## Any of

Type: object
Type: null

##

#### Config

Default: null

Current configuration values for the application. `null` if configuration is not requested.

## Any of

Type: object
Type: null

##

#### AppRemovedEvent

Type: object
No Additional Properties

##

#### Id

Type: string

Required roles: APPS_READ