Monitor n8n

There are three API endpoints you can call to check the status of your instance: /healthz, healthz/readiness, and /metrics.

healthz and healthz/readiness

The /healthz endpoint returns a standard HTTP status code. 200 indicates the instance is reachable. It doesn't indicate DB status. It's available for both self-hosted and Cloud users.

Access the endpoint:

<your-instance-url>/healthz

The /healthz/readiness endpoint is similar to the /healthz endpoint, but it returns a HTTP status code of 200 if the DB is connected and migrated and therefore the instance is ready to accept traffic.

Access the endpoint:

<your-instance-url>/healthz/readiness

Customizing health check endpoints

You can customize the health check endpoint path using the N8N_ENDPOINT_HEALTH environment variable.

metrics

The /metrics endpoint provides more detailed information about the current status of the instance.

Access the endpoint:

<your-instance-url>/metrics

Feature availability

The /metrics endpoint isn't available on n8n Cloud.

How do I enable metrics and health checks?

The /metrics endpoint is disabled by default. The health endpoint is always enabled on the main n8n server. For worker servers in queue mode, the health endpoint is disabled by default.

To enable them, configure your n8n instance:

# metrics <a href="#metrics" id="metrics"></a>
N8N_METRICS=true
# healthz <a href="#healthz" id="healthz"></a>
QUEUE_HEALTH_CHECK_ACTIVE=true

Refer to Configuration methods for more information on how to configure your instance using environment variables.