Description

Liveness check for the API itself: service name, running version, environment and the current server time. Useful for monitoring and for confirming your key and network path work.

Parameters

const res = await fetch("https://railway-engine.apkscope.workers.dev/v1/health", {
  headers: { "x-api-key": "YOUR_KEY" },
});

const { status, data, error } = await res.json();
if (status === "SUCCESS") {
  console.log(data.service, data.version, data.environment, data.time);
} else {
  console.error(status, error?.code, error?.message);
}

Notes

Requires the same x-api-key header as every other endpoint. Errors: 401 for a missing or invalid key, 429 RATE_LIMITED. Version strings are illustrative — read the live response.

Response Example