2 min read

Overview

As part of creating an add-on, QuickNode needs you to provide a way to check the health of your provisioning and RPC services. In this guide, we will go over simple guidelines that you should adhere to when creating a health check URL for your add-on.

We send healthcheck pings once every 10 minutes.

Ideal URL path

While not a requirement, the typical URL used for healthchecks is /healthz. At QuickNode, we also like /healthcheck. However, you can specify any URL you would like in our Marketplace developer portal.

Authentication

There should not be any authentication in front of your healthcheck URL. We want to be able to send a simple GET request to see the health. It is required that your healthcheck URL be openly accessible.

Expected response

When returning a response for your healthcheck URL, we require you to return a 200 OK HTTP response code if your services are healthy. If you respond with anything other than a 200 OK response code, we will assume your service is degraded and stop allowing customers to provision new installs.

Additionally, in the body of your health check response, we prefer but do not require a JSON format that is in the following shape:

{ "status": "ok" }

In-band checks

Your healthcheck should ideally perform a real call to your database or underlying datastore. This will allow us to have a strong understanding of the overall health and performance of your service.

Conclusion

Now that you've learned how to properly set up your healthcheck URL, we hope you can build an add-on with a bit more ease. For more information about Marketplace, check out QuickNode Marketplace or more Marketplace Guides.

Lastly, if you have any feedback or questions on this guide, let us know. We'd love to hear from you!