healthchecks_tcp_config

Parameters specific to TCP health check.

APIs.ioEngineeringPlatform

Properties

Name Type Description
method string The TCP connection method to use for the health check.
port integer Port number to connect to for the health check. Defaults to 80.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-healthchecks-tcp-config-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/healthchecks_tcp_config",
  "title": "healthchecks_tcp_config",
  "description": "Parameters specific to TCP health check.",
  "nullable": true,
  "properties": {
    "method": {
      "default": "connection_established",
      "description": "The TCP connection method to use for the health check.",
      "enum": [
        "connection_established"
      ],
      "type": "string"
    },
    "port": {
      "default": 80,
      "description": "Port number to connect to for the health check. Defaults to 80.",
      "type": "integer"
    }
  },
  "type": "object"
}