Skip to content

Get container health check

Request

Requires node-exec::read permission.

Security
JWTAuthorizer
Path
containerIDstringrequired

Container ID

clusterFQDNstringrequired

Node FQDN

curl -i -X GET \
  'https://apidocs.trustgrid.io/_mock/v2/cluster/{clusterFQDN}/exec/container/{containerID}/healthcheck' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
commandstring

Command

Example:"/bin/sh -c 'exit 0'"
intervalnumber

Interval

Example:10
retriesnumber

Number of health check retries before a container is marked unhealthy

Default:3
Example:10
startPeriodnumber

Grace period before health checks are monitored, in seconds

Example:10
timeoutnumber

Timeout

Example:10
Response
{
  "command": "/bin/sh -c 'exit 0'",
  "interval": 10,
  "retries": 10,
  "startPeriod": 10,
  "timeout": 10
}