magic_health_check

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
direction	string	The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where b
enabled	boolean	Determines whether to run healthchecks for a tunnel.
rate	string	How frequent the health check is run. The default value is `mid`.
target	string	The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to
type	string	The type of healthcheck to run, reply or request. The default value is `reply`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/magic_health_check",
  "title": "magic_health_check",
  "properties": {
    "direction": {
      "default": "unidirectional",
      "description": "The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel. Note in the case of bidirecitonal healthchecks, the target field in health_check is ignored as the interface_address is used to send traffic into the tunnel.",
      "enum": [
        "unidirectional",
        "bidirectional"
      ],
      "example": "bidirectional",
      "type": "string"
    },
    "enabled": {
      "default": true,
      "description": "Determines whether to run healthchecks for a tunnel.",
      "example": true,
      "type": "boolean"
    },
    "rate": {
      "default": "mid",
      "description": "How frequent the health check is run. The default value is `mid`.",
      "enum": [
        "low",
        "mid",
        "high"
      ],
      "example": "low",
      "type": "string"
    },
    "target": {
      "description": "The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.",
      "example": "203.0.113.1",
      "type": "string"
    },
    "type": {
      "default": "reply",
      "description": "The type of healthcheck to run, reply or request. The default value is `reply`.",
      "enum": [
        "reply",
        "request"
      ],
      "example": "request",
      "type": "string"
    }
  },
  "type": "object"
}