SmartAPI Uptime Monitoring
SmartAPI routinely checks all registered OpenAPI V3 API metadata and checks that all endpoints specified are working as expected. Based on this check an Uptime status will be assigned (pass, unknown, fail). Swagger V2 metadata will be skipped and not tested and be assigned an Uptime status of incompatible.
Each compatible document in our registry will be loaded into a monitoring module that will test all method endpoints we are interested in.
Default status upon start: 
At the end of the checks the final status is decided based on the collective results. While pass and fail statuses are more straight forward, unknown statuses can indicate a variety of issues. We try to give you some feedback in such case.
Only endpoints that use GET or POST methods are tested.
Only if you specify them as such. We can test a multiple combination of specifications, as long as you provide the appropriate requirements.
- For
GETendpoints they may or may not need parameters - For
POSTendpoints they may or may not need parameters/request body.
In some instances there may be an endpoint that requires a parameter that is dynamically generated (eg. async IDs) or you are unable to provide for some reason. For this kind of instances you can mark the parameter or body as required and NOT provide it. This particular scenario is skipped and it will not interfere with the overall score as long as other endpoints pass.
We have a timeout setting of 30s, if you believe that this will be an issue you can consider finding a faster example or follow our instructions to trigger a skip action as detailed above.
-
If any endpoint required a body or parameters and they were not included as examples, or providing an untestable endpoint eg. specified but not implemented.
-
One or more endpoints respond with a status code other than 200. -
Endpoints respond with success status codes of 200.
🟢 = OK , 🟠 = Skipped/Issue , 🔴 = Failed
-
[🟠 ,🟠 , 🟠, 🟠, 🟠] If no OK's and all skipped or issues present.
-
[🟢 ,🟢 ,🔴, 🟠, 🟠, 🟠] If any failed endpoints.
-
[🟢 ,🟢 , 🟠, 🟠, 🟠] No failing endpoints and at least one OK.
-
This item simply will not be tested. You can upgrade your metadata following this guide.
Clicking on the badge itself will display a description of what each status means in addition to a message indicating what endpoint failed and the error type when possible. Due to the wide variety of possibilities it's possible some issues cannot be captured to give back to the user. If you experience something like this please let us know.
Example of issue hint:
SmartAPI will automatically check uptime daily.
Log in and navigate to your dashboard, click on the purple button to trigger a check, your uptime status will be reassigned. It's important to wait while this check happens, depending on the number of endpoints this may take longer. Your report will be presented to you when it's done.
