List of filters for query results. See API documentation for "Query Methods" for more guidance.
No Additional Items[
[
"name",
"=",
"bob"
]
]
[
[
"OR",
[
[
[
"name",
"=",
"bob"
]
],
[
[
"name",
"=",
"larry"
]
]
]
]
]
Query options including pagination, ordering, and additional parameters.
No Additional PropertiesExtra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.
An array of field names describing the manner in which query results should be ordered. The field names may also have one of more of the following special prefixes: - (reverse sort direction), nulls_first: (place any null values at the head of the results list), nulls_last: (place any null values at the tail of the results list).
[
"size",
"-devname",
"nulls_first:-expiretime"
]
An array of field names specifying the exact fields to include in the query return. The dot character . may be used to explicitly select only subkeys of the query result.
[
"username",
"Authentication.status"
]
Return a numeric value representing the number of items that match the specified query-filters.
Return the JSON object of the first result matching the specified query-filters. The query fails if there specified query-filters return no results.
This specifies the beginning offset of the results array. When combined with the limit query-option it may be used to implement pagination of large results arrays. WARNING: some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.
This specifies the maximum number of results matching the specified query-filters to return. When combined wtih the offset query-option it may be used to implement pagination of large results arrays.
WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.
Force use of SQL for result filtering to reduce response time. May not work for all methods.
The display name of the application.
Must be at least 1 characters long
Unique identifier for the application instance.
Must be at least 1 characters long
Current operational state of the application.
Whether a newer version of the application is available for upgrade.
The latest available version string, or null if no updates are available.
Must be at least 1 characters long
Whether newer Docker images are available for the containers in this application.
Whether this is a custom application (true) or from a catalog (false).
Whether this application has been migrated from kubernetes.
Human-readable version string for display purposes.
Must be at least 1 characters long
Technical version identifier of the currently installed application.
Must be at least 1 characters long
Application metadata including description, category, and other catalog information.
Information about the running containers, ports, and resources used by this application.
No Additional PropertiesTotal number of containers currently running for this application.
Array of all port mappings used by the application.
No Additional ItemsThe port number inside the container.
The network protocol used.
"tcp"
"udp"
Array of host port mappings for this container port.
No Additional ItemsThe port number on the host system.
The IP address on the host system that the port is bound to.
Array of host IP addresses in use by the application.
No Additional ItemsDetailed information about each container in the application.
No Additional ItemsUnique identifier for the container.
Name of the service this container provides.
Docker image name and tag used by this container.
Array of port mappings for this container.
No Additional ItemsThe port number inside the container.
The network protocol used.
"tcp"
"udp"
Array of host port mappings for this container port.
No Additional ItemsCurrent state of the container.
Array of volume mounts configured for this container.
No Additional ItemsThe source path or volume name on the host system.
The mount path inside the container.
The mount mode (e.g., 'rw' for read-write, 'ro' for read-only).
The volume type.
"bind"
"volume"
Array of all volume mounts used by the application.
No Additional ItemsThe source path or volume name on the host system.
The mount path inside the container.
The mount mode (e.g., 'rw' for read-write, 'ro' for read-only).
The volume type.
"bind"
"volume"
Array of Docker image names used by the application.
No Additional ItemsMust be at least 1 characters long
Array of Docker networks associated with the application.
No Additional ItemsThe name of the Docker network.
Unique identifier for the Docker network.
Key-value pairs of labels associated with the network.
Additional Properties of any type are allowed.
Type: objectUser-provided notes or comments about this application instance.
Web portals and access points provided by the application (URLs, ports, etc.).
Detailed version information including changelog and upgrade notes. null if not available.
Current configuration values for the application. null if configuration is not requested.
The display name of the application.
Must be at least 1 characters long
Unique identifier for the application instance.
Must be at least 1 characters long
Current operational state of the application.
Whether a newer version of the application is available for upgrade.
The latest available version string, or null if no updates are available.
Must be at least 1 characters long
Whether newer Docker images are available for the containers in this application.
Whether this is a custom application (true) or from a catalog (false).
Whether this application has been migrated from kubernetes.
Human-readable version string for display purposes.
Must be at least 1 characters long
Technical version identifier of the currently installed application.
Must be at least 1 characters long
Application metadata including description, category, and other catalog information.
Information about the running containers, ports, and resources used by this application.
User-provided notes or comments about this application instance.
Web portals and access points provided by the application (URLs, ports, etc.).
Detailed version information including changelog and upgrade notes. null if not available.
Current configuration values for the application. null if configuration is not requested.