If this is your first time setting up API monitoring, we recommend starting with our Introduction to API monitoring.
Explore documentation
API monitor
APIs can be monitored by creating an HTTP status-code monitor or a keyword monitor. An uptime monitor will only check the returned status code, while a keyword monitor can check for a specific string in the API response.
Creating an API monitor:
- Go to Monitors → Create monitor.
- Change the Alert us when the host above selection to Becomes unavailable.
- Enter the API's URL in the text input.
- Go to Advanced settings → Request parameters.
- Select the HTTP method you want to use for the requests.
- (Optional) Include request body parameters in the request body.
- Select an authentication method: either use request headers, or HTTP authentication.
- Click Create monitor.