API call for server status and test connect from external App

Questions
1

I am building an external APP w/ N8N integration, I cannot seem to find an API call that returns just a simple return of good and up, I read somewhere the API call Health or HealthZ but neither are valid, I was able to get a return on workflows but that returns a ton of data, is there a simple yes you are connected and server is up type API call?

2

It looks like your topic is missing some important information. Could you provide the following if applicable.

  • n8n version:
  • Database (default: SQLite):
  • n8n EXECUTIONS_PROCESS setting (default: own, main):
  • Running n8n via (Docker, npm, n8n cloud, desktop app):
  • Operating system:
3

I am a cloud user, on Starter paid plan, I created credential for the N8N API and using a valid API Key which is returning a response in POSTMAN.

4

Hi, I found this confusing when trying to use the /healthz endpoint too.

While most endpoints are called like this:
https://{yourinstance}/api/v1/workflows

The /heathz endpoint doesn’t include api or version. So you call it like this:
https://{yourinstance}/healthz

5

Great information, thank you for the response, I will give this whirl.

1 Like
6

Did this end up working for you?

7

It did, exactly what I was looking for thanks.

1 Like
8

This topic was automatically closed 90 days after the last reply. New replies are no longer allowed.