NAME
API::Docker::Type::ContainerState - Container's running state
VERSION
version 0.004
DESCRIPTION
Generated from the ContainerState definition of spec/v1.51.yaml.
It's part of ContainerJSONBase and will be returned by the "inspect" command.
status
String representation of the container state. Can be one of "created", "running", "paused", "restarting", "removing", "exited", or "dead".
running
Whether this container is running.
Note that a running container can be paused. The Running and Paused booleans are not mutually exclusive:
When pausing a container (on Linux), the freezer cgroup is used to suspend all processes in the container. Freezing the process requires the process to be running. As a result, paused containers are both Running and Paused.
Use the Status field instead to determine if a container's state is "running".
paused
Whether this container is paused.
restarting
Whether this container is restarting.
oom_killed
Whether a process within this container has been killed because it ran out of memory since the container was last started. Serialised as OOMKilled -- spelled out, because deriving it from the Perl name would produce OomKilled.
dead
Undocumented upstream. The boolean beside "status"'s dead value, as "running", "paused" and "restarting" stand beside theirs. The swagger's example is false.
pid
The process ID of this container.
exit_code
The last exit code of this container.
error
Undocumented upstream.
started_at
The time when this container was last started.
finished_at
The time when this container last exited.
health
Health stores information about the container's healthcheck results. See API::Docker::Type::Health.
SUPPORT
Issues
Please report bugs and feature requests on GitHub at https://github.com/Getty/p5-api-docker/issues.
CONTRIBUTING
Contributions are welcome! Please fork the repository and submit a pull request.
AUTHOR
Torsten Raudssus <getty@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2026 by Torsten Raudssus <torsten@raudssus.de> https://raudssus.de/.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.