Category: How do I do X?
Updated

This solution is summarized from an archived support forum post. This information may have changed. If you notice an error, please let us know in Discord.

How Do I Monitor If My Appsmith Instance Is Up and Running?

Issue

As an engineer using AppSmith, I wanted to monitor its uptime using tools like Pingdom or Uptime Robot. Initially, I used "/" as the default URI, but it didn't work correctly as Pingdom detected it as up even when AppSmith was showing an error page. I was unsure if there was a specific URI, like "/healthcheck," that AppSmith responded to with an error status code when it wasn't working correctly. Later, I found out that hitting the "/api/v1/users/features" endpoint in the latest version of AppSmith could determine if AppSmith was healthy.

Resolution

Appsmith provides a purpose-built health check endpoint at:

/api/v1/health

This endpoint checks the health of core internal services including:

  • MongoDB (Appsmith's primary data store)
  • Redis (used for session and cache management)
  • The Java backend server

If any of these services are unavailable or unresponsive, the /api/v1/health endpoint will return an appropriate error code, allowing monitoring tools to detect that the instance is not fully operational.

Documentation: Appsmith Health Check API