Cluster API health¶

Cluster API documentation for health

Health¶

GET /health/{service}¶

Get a service health

Parameters:

service – The service name

Response JSON Object:

[] (object) –
[].Node (string) – Name of the node used by the service.
[].CheckID (string) – Id to identify the type.
[].Name (string) – CheckID with name of the service.
[].Status (string) – Status of the service.
[].Notes (string) – Notes related to the service.
[].Output (string) – Output associated to the service.
[].ServiceID (string) – The name of the service.
[].ServiceName (string) – Name of the service.
[].ServiceTags[] (string) – List of tags of the service.
[].Definition.HTTP (string) –
[].Definition.Header (string) –
[].Definition.Method (string) –
[].Definition.TLSSkipVerify (boolean) –
[].Definition.TCP (string) –
[].Definition.Interval (string) –
[].Definition.Timeout (string) –
[].Definition.DeregisterCriticalServiceAfter (string) –

Example response:

[
  {
    "Node": "",
    "CheckID": "",
    "Name": "",
    "Status": "",
    "Notes": "",
    "Output": "",
    "ServiceID": "",
    "ServiceName": "",
    "ServiceTags": [
      ""
    ],
    "Definition": {
      "HTTP": "",
      "Header": "",
      "Method": "",
      "TLSSkipVerify": false,
      "TCP": "",
      "Interval": "",
      "Timeout": "",
      "DeregisterCriticalServiceAfter": ""
    }
  }
]