pause

suspend fun pause(id: String): Result<Unit, ErrorResponse>

Pause a container

Use the freezer cgroup to suspend all processes in a container.

Traditionally, when suspending a container the state of the container is preserved, for example, process environment variables and memory contents.

When the container is resumed, it will continue from where it left off.

Return

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

Parameters

id

Container ID or name.