Kotlin Multiplatform Client for Docker/dev.limebeck.libs.docker.client.api/Containers/getList

getList

suspend fun getList(all: Boolean = false, limit: Int? = null, size: Boolean = false, filters: Map<String, List<String>>? = null): Result<List<ContainerSummary>, ErrorResponse>

List containers

Returns a list of containers. For details on the format, see the getInfo. Note that it uses a different, smaller representation of a container than inspecting a single container. For example, the list of linked containers is not propagated.

Return

Operation response on success, or the Docker error response. Transport failures and cancellation can throw.

Parameters

all

Include stopped containers; false lists running containers.

limit

Maximum number of entries; null leaves the daemon default.

size

Include container filesystem sizes.

filters

Docker filter names mapped to values, for example mapOf("status" to listOf("running")) for listing, or mapOf("label" to listOf("app=worker")). Allowed keys depend on the operation; the SDK encodes the map as JSON and Docker validates it.