Skip to content

docs: Add new N8N_ENDPOINT_HEALTH #4236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dariacodes wants to merge 5 commits into
base: main
Choose a base branch
from
+22 −5
Open

docs: Add new N8N_ENDPOINT_HEALTH #4236

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f4c64aa
Add health endpoint to endpoints env var document
dariacodes Feb 16, 2026
8df175e
Add info about custom health endpoint to Google Cloud Run document
dariacodes Feb 16, 2026
2fe1e75
Add info about custom health endpoint to Monitoring and Queue mode
dariacodes Feb 16, 2026
90ea1b3
Improve wording
dariacodes Feb 16, 2026
5a6c79e
Switch to using a note in Monitoring
dariacodes Feb 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/hosting/configuration/environment-variables/endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,6 @@ This page lists environment variables for customizing endpoints in n8n.
| `N8N_ENDPOINT_WEBHOOK` | String | `webhook` | The path used for webhook endpoint. |
| `N8N_ENDPOINT_WEBHOOK_TEST` | String | `webhook-test` | The path used for test-webhook endpoint. |
| `N8N_ENDPOINT_WEBHOOK_WAIT` | String | `webhook-waiting` | The path used for waiting-webhook endpoint. |
| `N8N_ENDPOINT_HEALTH` | String | `healthz` | The path used for health check endpoint. |
| `WEBHOOK_URL` | String | - | Used to manually provide the Webhook URL when running n8n behind a reverse proxy. See [here](/hosting/configuration/configuration-examples/webhook-url.md) for more details. |
| `N8N_DISABLE_PRODUCTION_MAIN_PROCESS` | Boolean | `false` | Disable production webhooks from main process. This helps ensure no HTTP traffic load to main process when using webhook-specific processes. |
12 changes: 9 additions & 3 deletions docs/hosting/installation/server-setups/google-cloud-run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ You can also explicitly enable the Cloud Run API (even if you don't do this, it
gcloud services enable run.googleapis.com
```

/// warning | Required: Custom health check endpoint
Google Cloud Run reserves `/healthz` for its own health checks. Since n8n uses this path by default, it can conflict and cause connection issues in the workflow canvas. To fix this, set the `N8N_ENDPOINT_HEALTH` environment variable to a custom path (included in the deployment commands below).
///

To deploy n8n:

```sh
Expand All @@ -47,7 +51,8 @@ gcloud run deploy n8n \
--allow-unauthenticated \
--port=5678 \
--no-cpu-throttling \
--memory=2Gi
--memory=2Gi \
--set-env-vars="N8N_ENDPOINT_HEALTH=health"
```

(you can specify whichever region you prefer, instead of "us-west1")
Expand All @@ -64,7 +69,8 @@ gcloud run deploy n8n \
--port=5678 \
--no-cpu-throttling \
--memory=2Gi \
--scaling=1
--scaling=1 \
--set-env-vars="N8N_ENDPOINT_HEALTH=health"
```

This does not prevent data loss completely, such as whenever the Cloud Run service is re-deployed/updated. If you want truly persistant data, you should refer to the instructions below for how to attach a database.
Expand Down Expand Up @@ -190,7 +196,7 @@ gcloud run deploy n8n \
--port=5678 \
--memory=2Gi \
--no-cpu-throttling \
--set-env-vars="N8N_PORT=5678,N8N_PROTOCOL=https,DB_TYPE=postgresdb,DB_POSTGRESDB_DATABASE=n8n,DB_POSTGRESDB_USER=n8n-user,DB_POSTGRESDB_HOST=/cloudsql/$PROJECT_ID:$REGION:n8n-db,DB_POSTGRESDB_PORT=5432,DB_POSTGRESDB_SCHEMA=public,GENERIC_TIMEZONE=UTC,QUEUE_HEALTH_CHECK_ACTIVE=true" \
--set-env-vars="N8N_PORT=5678,N8N_PROTOCOL=https,N8N_ENDPOINT_HEALTH=health,DB_TYPE=postgresdb,DB_POSTGRESDB_DATABASE=n8n,DB_POSTGRESDB_USER=n8n-user,DB_POSTGRESDB_HOST=/cloudsql/$PROJECT_ID:$REGION:n8n-db,DB_POSTGRESDB_PORT=5432,DB_POSTGRESDB_SCHEMA=public,GENERIC_TIMEZONE=UTC,QUEUE_HEALTH_CHECK_ACTIVE=true" \
--set-secrets="DB_POSTGRESDB_PASSWORD=n8n-db-password:latest,N8N_ENCRYPTION_KEY=n8n-encryption-key:latest" \
--add-cloudsql-instances=$PROJECT_ID:$REGION:n8n-db \
--service-account=n8n-service-account@$PROJECT_ID.iam.gserviceaccount.com
Expand Down