app.image.query

Query all docker images with query-filters and query-options.

query-options.extra.parse_tags is a boolean which when set will have normalized tags to be retrieved.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: filters

filters

Type: array Default: []

List of filters for query results. See API documentation for "Query Methods" for more guidance.

No Additional Items

Each item of this array must be:

Type: object

Examples:

[
    [
        "name",
        "=",
        "bob"
    ]
]

[
    [
        "OR",
        [
            [
                [
                    "name",
                    "=",
                    "bob"
                ]
            ],
            [
                [
                    "name",
                    "=",
                    "larry"
                ]
            ]
        ]
    ]
]

Parameter 2: options

options

Type: object

Default:

{ "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

Query options including pagination, ordering, and additional parameters.

No Additional Properties

extra

Extra

Type: object Default: {}

Extra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.

order_by

Order By

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Type: string

Example:

[
    "size",
    "-devname",
    "nulls_first:-expiretime"
]

select

Select

Type: array Default: []

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.

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

Example:

[
    "username",
    "Authentication.status"
]

count

Count

Type: boolean Default: false

Return a numeric value representing the number of items that match the specified query-filters.

get

Get

Type: boolean Default: false

Return the JSON object of the first result matching the specified query-filters. The query fails if there specified query-filters return no results.

offset

Offset

Type: integer Default: 0

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.

limit

Limit

Type: integer Default: 0

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_sql_filters

Force Sql Filters

Type: boolean Default: false

Force use of SQL for result filtering to reduce response time. May not work for all methods.

Return value

Result

Any of

• Option 1
• AppImageQueryResultItem
• Option 3

Type: array of object
No Additional Items

Each item of this array must be:

AppImageQueryResultItem

Type: object
No Additional Properties

id

Id

Type: string

Unique identifier for the container image (usually SHA256 hash).

Must be at least 1 characters long

repo_tags

Repo Tags

Type: array of string

Array of repository tags associated with this image.

No Additional Items

Each item of this array must be:

Type: string

repo_digests

Repo Digests

Type: array of string

Array of repository digests (content-addressable identifiers) for this image.

No Additional Items

Each item of this array must be:

Type: string

size

Size

Type: integer

Size of the container image in bytes.

dangling

Dangling

Type: boolean

Whether this is a dangling image (no tags or references).

update_available

Update Available

Type: boolean

Whether a newer version of this image is available for download.

created

Created

Type: string

Timestamp when the container image was created (ISO format).

author

Author

Type: string

Author or maintainer of the container image.

comment

Comment

Type: string

Comment or description provided by the image author.

parsed_repo_tags

Parsed Repo Tags

Parsed repository tag information or null if not available.

Any of

• Option 1
• Option 2

Type: array of object
No Additional Items

Each item of this array must be:

AppImageParsedRepoTags

Type: object
No Additional Properties

reference Required

Reference

Type: string

Full reference to the container image (registry/repository:tag).

image Required

Image

Type: string

Container image name without registry or tag.

tag Required

Tag

Type: string

Image tag (version) or digest identifier.

registry Required

Registry

Type: string

Container registry hostname (e.g., docker.io, quay.io).

complete_tag Required

Complete Tag

Type: string

Complete image reference including registry, image name, and tag.

reference_is_digest Required

Reference Is Digest

Type: boolean

Whether the reference uses a digest hash instead of a tag name.

Type: null

AppImageQueryResultItem

Type: object
No Additional Properties

id

Id

Type: string

Unique identifier for the container image (usually SHA256 hash).

Must be at least 1 characters long

repo_tags

Repo Tags

Type: array of string

Array of repository tags associated with this image.

No Additional Items

Each item of this array must be:

Type: string

repo_digests

Repo Digests

Type: array of string

Array of repository digests (content-addressable identifiers) for this image.

No Additional Items

Each item of this array must be:

Type: string

size

Size

Type: integer

Size of the container image in bytes.

dangling

Dangling

Type: boolean

Whether this is a dangling image (no tags or references).

update_available

Update Available

Type: boolean

Whether a newer version of this image is available for download.

created

Created

Type: string

Timestamp when the container image was created (ISO format).

author

Author

Type: string

Author or maintainer of the container image.

comment

Comment

Type: string

Comment or description provided by the image author.

parsed_repo_tags

Parsed Repo Tags

Parsed repository tag information or null if not available.

Any of

• Option 1
• Option 2

Type: array
No Additional Items

Each item of this array must be:

Type: object

Type: null

Type: integer

Required roles: APPS_READ