mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-24 08:12:15 +00:00
26 lines
1.2 KiB
Plaintext
26 lines
1.2 KiB
Plaintext
---
|
|
title: ZITADEL Ready and Health Endpoints
|
|
description: "Check ZITADEL's readiness and health status using /debug/ready and /debug/healthz endpoints for system monitoring and maintenance"
|
|
sidebar_label: Ready and Health Endpoints
|
|
---
|
|
|
|
ZITADEL exposes a `Ready`- and `Healthy` endpoint to allow external systems like load balancers, orchestration systems, uptime probes and others to check the status.
|
|
|
|
## Ready
|
|
|
|
The `Ready` endpoint is located on the path `/debug/ready` and allows systems to probe if a ZITADEL process is ready to serve and accept traffic.
|
|
This endpoint is useful for operations like [zero downtime upgrade](../../concepts/architecture/solution#zero-downtime-updates) since it allows systems like Kubernetes to verify that ZITADEL is working on something (e.g. database schema migration) but is not yet ready to accept traffic.
|
|
|
|
<Callout>
|
|
In Kubernetes this is called the `readinessProbe`.
|
|
</Callout>
|
|
|
|
## Healthy
|
|
|
|
The `Health` endpoint is located on the path `/debug/healthz` and allows systems to probe if a ZITADEL process is still alive.
|
|
This helps system like kubernetes or a load balancer to observe if the process is still alive to accept traffic.
|
|
|
|
<Callout>
|
|
In Kubernetes this is called the `livenessProbe`.
|
|
</Callout>
|