If your API implements the Swagger 2.0 or OpenAPI spec, you can import the swagger.json spec. The importer parses your spec and prompts you to make some decisions about which requests are to be imported and how. Navigate to the Create API Check page and select the Import from Swagger / OpenAPI button.
Light mode interface
Add a valid URL to the Swagger / OpenAPI specification and click the Import Specfication button.

​
Configuring Your Checks

​
Groups & Tagging

You can add your OpenAPI endpoints checks to a group to help you manage them.
Light mode interface
A tag will be added to each imported check.

​
Name

The name of the check will be the name of the OpenAPI endpoint.

​
Response time limits

Sometimes APIs can be slow, but not broken. We call this degraded. You can set response time limits to specify when an API check should be marked as degraded and when it should be marked as failed.

​
Assertions

This is where you determine whether the response of the HTTP request is correct or not. You can assert on different sources. These could be:
  • The HTTP status code returned from the API
  • Something missing or required within the response body
  • A specific response header
  • A specific response time
Read more about assertions

​
Scheduling & locations

You can configure your checks to run from our public locations, or use a Checkly Agent to host your own private locations. If you don’t select more than one location and you’ve disabled retrying checks from the same location, we will pick a random location when retrying checks. Checkly runs your API checks based on an interval you set. The shortest interval you can run is every 10 seconds and the longest is every 24 hours.
A 1-second interval is available upon request — contact us if you’d like to learn more.

​
Retries & alerting

Select your preferred retry strategy for failed checks. Choose which alert channels to get notified through when your check runs into issues. If we don’t have your preferred alert method, why not try out our webhooks?

​
Testing

You can run your check as an E2E test locally or from your CI/CD pipeline to validate your freshly deployed application. Use the Checkly CLI, or configure integrations with Vercel and GitHub.