GET/api/health

Health check

Simple unauthenticated liveness check for the Next.js API process. It performs no database, Redis, or downstream dependency checks and returns a fixed status/version payload when the process can serve HTTP requests.

Response body

Success response 200 · schema HealthResponse

statusstringRequired

Always ok when the API process is reachable.

Enum: ok

versionstringRequired

Hardcoded API version string returned by the handler.

Response codes

200

API process is alive and responding.

GET /api/health

cURL

curl -X GET "https://algapsa.com/api/health" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/health", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/health");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "status": "ok",
  "version": "string"
}