register-health-check
Defines and registers a health check with Consul, specifying name, service association, TTL, HTTP endpoint, interval, and timeout for monitoring service status and availability.
Instructions
Register a health check with Consul
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| http | No | HTTP endpoint to check | |
| id | No | ID of the health check (defaults to name if not provided) | |
| interval | No | Interval for the check (e.g., '10s', '1m') | |
| name | No | Name of the health check | |
| notes | No | Notes about the health check | |
| serviceId | No | ID of the service to associate the check with | |
| timeout | No | Timeout for the check (e.g., '5s', '30s') | |
| ttl | No | Time to live for the check (e.g., '10s', '1m') |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"http": {
"default": "",
"description": "HTTP endpoint to check",
"type": "string"
},
"id": {
"default": "",
"description": "ID of the health check (defaults to name if not provided)",
"type": "string"
},
"interval": {
"default": "",
"description": "Interval for the check (e.g., '10s', '1m')",
"type": "string"
},
"name": {
"default": "",
"description": "Name of the health check",
"type": "string"
},
"notes": {
"default": "",
"description": "Notes about the health check",
"type": "string"
},
"serviceId": {
"default": "",
"description": "ID of the service to associate the check with",
"type": "string"
},
"timeout": {
"default": "",
"description": "Timeout for the check (e.g., '5s', '30s')",
"type": "string"
},
"ttl": {
"default": "",
"description": "Time to live for the check (e.g., '10s', '1m')",
"type": "string"
}
},
"type": "object"
}