Interface ContainerImagesApiListContainerImagesRequest

Hierarchy

  • ContainerImagesApiListContainerImagesRequest

Properties

filterTags?: string

Comma-separated key:value tags. An image must match every tag. Wildcards, negation (-key:value), spaces, and IN (...) are not supported. Use keys such as image_registry and image_tag. To match any of several values of the same key, make one request per value.

groupBy?: string

Comma-separated list of up to three tag keys, such as image_registry,image_tag. Returns container_image_group objects with counts and tags. Grouped results ignore sort and do not support pagination. Images missing a grouping key are excluded. An image with multiple values for a grouping tag can appear in multiple groups. Grouped results may be incomplete. Compare counts only within the returned groups; they do not establish the most common tags or proportions across the inventory. For inventory-wide comparisons, omit group_by, keep the same filters, paginate all results, and deduplicate by returned image ID. For an inventory total, use meta.pagination.total from a query without grouping.

pageCursor?: string

Opaque cursor from meta.pagination.next_cursor for individual images. Keep the same filters and sort order. Stop when absent or empty. Grouped queries do not support pagination.

pageSize?: number

Maximum number of results returned. Grouped queries default to 100, with a maximum of 1000 groups. Without grouping, queries default to 1000, with a maximum of 10000 images. Minimum is 1.

sort?: string

Attribute to sort individual images by, such as size or container_count. Defaults to image_name in ascending order. Prefix the attribute with - for descending order, such as -size. Ignored when group_by is specified.

Generated using TypeDoc