worker-health-check-config.md

title	isDefaultIndex	generated
WorkerHealthCheckConfig	false	true

import MemberInfo from '@site/src/components/MemberInfo'; import GenerationInfo from '@site/src/components/GenerationInfo'; import MemberDescription from '@site/src/components/MemberDescription';

WorkerHealthCheckConfig

Specifies the configuration for the Worker's HTTP health check endpoint.

interface WorkerHealthCheckConfig {
    port: number;
    hostname?: string;
    route?: string;
}

port

<MemberInfo kind="property" type={number} />

The port on which the worker will listen

hostname

<MemberInfo kind="property" type={string} default="'localhost'" />

The hostname

route

<MemberInfo kind="property" type={string} default="'/health'" />

The route at which the health check is available.