summaryrefslogtreecommitdiff
path: root/API.md
diff options
context:
space:
mode:
authorAshley Cui <ashleycui16@gmail.com>2019-08-19 12:14:54 -0400
committerAshley Cui <ashleycui16@gmail.com>2019-08-19 12:14:54 -0400
commit8c7014f11d02c324b56779ef277e0c9365ce1c86 (patch)
tree52564628f753235de5e3ba416ae6340e004936ac /API.md
parentc137e8fcf95b441b5002ec1b39e6cc131471b88a (diff)
downloadpodman-8c7014f11d02c324b56779ef277e0c9365ce1c86.tar.gz
podman-8c7014f11d02c324b56779ef277e0c9365ce1c86.tar.bz2
podman-8c7014f11d02c324b56779ef277e0c9365ce1c86.zip
Implement healthcheck for remote client
Previously unimplemented. Works the same way the local one does, except its remote. Signed-off-by: Ashley Cui <ashleycui16@gmail.com>
Diffstat (limited to 'API.md')
-rwxr-xr-xAPI.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/API.md b/API.md
index 8d53a77d3..c3a6ea4c8 100755
--- a/API.md
+++ b/API.md
@@ -87,6 +87,8 @@ in the [API.md](https://github.com/containers/libpod/blob/master/API.md) file in
[func GetVolumes(args: []string, all: bool) Volume](#GetVolumes)
+[func HealthCheckRun(nameOrID: string) string](#HealthCheckRun)
+
[func HistoryImage(name: string) ImageHistory](#HistoryImage)
[func ImageExists(name: string) int](#ImageExists)
@@ -681,6 +683,12 @@ GetVersion returns version and build information of the podman service
method GetVolumes(args: [[]string](#[]string), all: [bool](https://godoc.org/builtin#bool)) [Volume](#Volume)</div>
GetVolumes gets slice of the volumes on a remote host
+### <a name="HealthCheckRun"></a>func HealthCheckRun
+<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;">
+
+method HealthCheckRun(nameOrID: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div>
+HealthCheckRun executes defined container's healthcheck command
+and returns the container's health status.
### <a name="HistoryImage"></a>func HistoryImage
<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;">