Instances Health Check Create
post
/api/v2/instances/{id}/health_check/
Manually Initiate a Health Check
For purposes of error remediation or debugging, a health check can be manually initiated by making a POST request to this endpoint.
This will submit the work unit to the target node through the receptor mesh and wait for it to finish. The model will be updated with the result. Up-to-date values of the fields will be returned in the response data.
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : InstanceHealthCheck
Type:
Show Source
object-
capacity:
integer
Title:
CapacityRead Only:true -
cpu:
string(decimal)
Title:
CpuRead Only:true -
cpu_capacity:
integer
Title:
Cpu capacityRead Only:true -
errors:
string
Title:
ErrorsRead Only:trueMinimum Length:1Any error details from the last health check. -
hostname:
string
Title:
HostnameRead Only:trueMinimum Length:1 -
ip_address:
string
Title:
Ip addressRead Only:trueMinimum Length:1 -
last_health_check:
string(date-time)
Title:
Last health checkRead Only:trueLast time a health check was ran on this instance to refresh cpu, memory, and capacity. -
mem_capacity:
integer
Title:
Mem capacityRead Only:true -
memory:
integer
Title:
MemoryRead Only:trueTotal system memory of this instance in bytes. -
uuid:
string
Title:
UuidRead Only:trueMinimum Length:1 -
version:
string
Title:
VersionRead Only:trueMinimum Length:1
Response
Supported Media Types
- application/json
201 Response
Root Schema : InstanceHealthCheck
Type:
Show Source
object-
capacity:
integer
Title:
CapacityRead Only:true -
cpu:
string(decimal)
Title:
CpuRead Only:true -
cpu_capacity:
integer
Title:
Cpu capacityRead Only:true -
errors:
string
Title:
ErrorsRead Only:trueMinimum Length:1Any error details from the last health check. -
hostname:
string
Title:
HostnameRead Only:trueMinimum Length:1 -
ip_address:
string
Title:
Ip addressRead Only:trueMinimum Length:1 -
last_health_check:
string(date-time)
Title:
Last health checkRead Only:trueLast time a health check was ran on this instance to refresh cpu, memory, and capacity. -
mem_capacity:
integer
Title:
Mem capacityRead Only:true -
memory:
integer
Title:
MemoryRead Only:trueTotal system memory of this instance in bytes. -
uuid:
string
Title:
UuidRead Only:trueMinimum Length:1 -
version:
string
Title:
VersionRead Only:trueMinimum Length:1