For more information about API Checks in general, see our API Check article.
Request Step
A Request Step makes an HTTP request to some endpoint and collects data from that interaction. Unlike other check types, API Checks do not require an initial URL to start the check. All HTTP requests are configured within Request Steps.
Example
In the example below, we are sending JSON payload via a POST request. We are also setting the Content-Type header to indicate that the payload is JSON.
Methods
We current support the following HTTP methods:
- GET
- HEAD
- POST (can send post data)
- PUT (can send post data)
- DELETE
Headers
A request can have multiple request headers. The header name can be selected from a list or a custom header name can be entered. Variables can be used in the header name or value. It is important to note that you must ensure that the header is valid.
Failures
Non-200 level response codes do not automatically fail a Request Step. Requests are only considered failures when the request/response cycle cannot be completed. Some examples of when this might occur are when the TCP connection is interrupted, the server aborts the request, the server fails to respond, or the request times out.