Kotlin Multiplatform Client for Docker/dev.limebeck.libs.docker.client.api/Volumes/remove

remove

suspend fun remove(name: String, force: Boolean = false): Result<Unit, ErrorResponse>

Deletes a volume and its persistent data. Invoke only for an explicit data-deletion action. Container removal does not require deleting its named volumes.

Return

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

Parameters

name

Resource name or ID accepted by Docker.

force

Request forced removal; Docker still enforces its resource constraints.