You can use these checks to monitor a REpresentational State Transfer (REST) API. You enter the method next to the url and you can execute the query. You also have the option of defining a body, additional parameters parameters and headers (e.g. for Bearer-Auth-Token), which we transmit when the interface is called. In addition to the maximum duration max_time, response size max_size and min_size, you can define a condition condition. Interfaces that deliver a JSON-formatted response can be evaluated using it. You enter an expression that will be applied to the result. e.g. message.return_code == "success". If the API responds to the call with {"message": {"return_code" : "success"}}, the result is valid. In other cases we start the alert.
urlresponse_codemethodconditionbodyparametersheadersmax_timemax_sizemin_sizeHere we answer questions about server monitoring from Livewatch. If you have a question that we have not yet answered here, please contact us.
A “REST API check” refers to checking a RESTful API (Representational State Transfer Application Programming Interface) for its availability, functionality and conformity to the defined standards. REST is an architectural style for developing web services that manipulates resources through standardized HTTP methods (such as GET, POST, PUT, and DELETE).
A REST API check can include various aspects:
Endpoints and Resources: Review of available API endpoints and the resources provided by those endpoints. This includes checking GET requests to ensure that the expected data is returned.
HTTP Methods: Verification of support and correct use of various HTTP methods such as GET, POST, PUT and DELETE according to API specifications.
Parameter validation: Verifying that the API endpoints correctly respond to requests with the required parameters and are able to properly handle invalid or missing parameters.
Authentication and Authorization: Verification of authentication and authorization to ensure that only authorized users or applications can access protected resources.
Status Codes: Checking the returned HTTP status codes to ensure they comply with the API specifications. For example, successful requests should return status code 200 (OK).
Response data format: Check the format of the returned data, such as JSON or XML, to ensure that it meets expectations.
Error Handling: Review error handling to ensure that the API returns appropriate error messages when unexpected situations occur.
REST API checks are often used as part of API monitoring to ensure that an API is functioning properly and delivering expected results. This is particularly important in distributed application landscapes where different services communicate with each other.
There are various tools and services specifically designed for testing REST APIs that can perform automated checks. These checks can also be integrated into Continuous Integration (CI) and Continuous Deployment (CD) processes to ensure that changes to an API do not negatively impact its functionality.
Our server monitoring instances are located worldwide. So you get a complete picture of your system health and are also informed about disturbances in distant locations.
Continuous monitoring of your website
Detailed logging of the availability of your website
Create your own exams and monitor your infrastructure with ease
Register your account free of charge and without obligation.
Let us explain our server monitoring offer in a 60-second video.
60 seconds of video - all about server monitoring
