Healthcheck API

Starting in Streamwell 1.8 there is an API endpoint that allows you to check the overall health of the server 🩺

The endpoint is: /api/healthcheck.php

To run a healthcheck, send a GET request containing a base64-encoded "key" value that matches the system key you set when you installed Streamwell. For example, if your server is at 192.168.0.100 and your system key is "nevergonnagiveyouup", you would send a GET request to this URL (or visit it with a web browser):

http://192.168.0.100/api/healthcheck.php?key=bmV2ZXJnb25uYWdpdmV5b3V1cA

Streamwell then checks on two things:

1) The Apache, PHP and database services are running properly (we treat these as one service because they all need each other to do anything useful)

2) The streaming engine is online and responding (the star of the show)

If these conditions are true, you will receive a 200 response with the message "Streamwell is healthy". O glory day! Otherwise you would receive a 400 if the request did not include a key, 401 if the key is incorrect, and a 418 if the engine is offline. If you receive no response at all, there's a good chance that either your server or networking has gone offline 😅

For security purposes it is recommended to only conduct these checks from the same local network you are running Streamwell on. We plan to further expose API access in future releases and, upon request, can help you achieve access to certain API elements that may already be available.