Cloudflare.Diagnostics reference

EndpointHealthcheck

Source: src/Cloudflare/Diagnostics/EndpointHealthcheck.ts

A Magic Transit / Magic WAN endpoint healthcheck — a continuous ICMP probe of an on-net IP address used to monitor reachability of hosts behind Magic tunnels.

The endpoint must be a private (on-net) IP; Cloudflare rejects public IPs with the typed InvalidHealthcheckEndpoint error. The endpoint is mutable in place via PUT (the UUID is stable across updates), but name is create-only — changing it triggers a replacement.

EndpointHealthcheck: Creating an endpoint healthcheck

Probe an on-net host

const check = yield* Cloudflare.Diagnostics.EndpointHealthcheck("core-router", {
  endpoint: "10.0.0.1",
});

With an explicit name

const check = yield* Cloudflare.Diagnostics.EndpointHealthcheck("core-router", {
  endpoint: "10.0.0.1",
  name: "core-router-probe",
});

EndpointHealthcheck: Updating

// Changing `endpoint` updates the same healthcheck in place.
const check = yield* Cloudflare.Diagnostics.EndpointHealthcheck("core-router", {
  endpoint: "10.0.0.2",
});