Optional filterOptional groupComma-separated list of up to three tag keys to group containers by. Returns container_group
objects with counts and tags. Grouped results ignore sort and do not support pagination.
Containers with multiple values for a grouping tag can appear in multiple groups.
Summing group counts can overcount distinct containers.
Optional pageString to query the next page of results.
This key is provided with each valid response from the API in meta.pagination.next_cursor.
Optional pageMaximum number of results returned. For grouped results, defaults to 100 with a maximum
of 1000 groups.
Optional sortAttribute to sort individual containers by: name, created_at, started_at, state,
container_id, host, image_name, or image_digest. Defaults to started_at in ascending
order. Prefix the attribute with - for descending order, such as -started_at.
Ignored when group_by is specified.
Generated using TypeDoc
Comma-separated
key:valuetags. A container must match every tag. Wildcards, negation (-key:value), spaces, andIN (...)are not supported. To cover several hosts, make one request per host.