Skip to main content
Send one HTTP GET request to a URL and exit 0 if the server answers 200, or exit 1 otherwise. The command needs no root key and never contacts the Unkey API. Use it as a small probe for CI pipelines, load balancer checks, and monitoring scripts, for example against the hostname of a deployment.

Usage

The URL is required. Without it, the command exits 1 with you must provide a url like so: 'unkey healthcheck <url>'. The command has no flags.

Behavior

Redirects are followed and there’s no request timeout, so a server that never answers keeps the command waiting. A 200 response prints ✓ Healthcheck passed: <url> returned 200 and exits 0. Any other status exits 1 with healthcheck failed with status code <code>. A connection error exits 1 with failed to perform healthcheck: followed by the underlying error.

Examples

Probe a deployment hostname:
Alert when a service is down:
Gate a pipeline step:
Last modified on September 29, 2026