Reduce Downtime with 24/7 API Monitoring

Minimize incident response time with accurate and reliable alerts. Secure your app and service availability and performance with a code-first API monitoring solution. Powered by Playwright.

Start for free

api.check.tsnew ApiCheck('hello-api-1', {
  name: 'Hello API',
  activated: true,
  request: {
    method: 'GET',
    url: 'https://api.checklyhq.com/public-stats',
    assertions: [
      AssertionBuilder.statusCode().equals(200)
    ],
  }
})

Trusted By Engineering Teams At

import { test, expect } from '@playwright/test'

const baseUrl = 'https://api.myproduct.com/v1'

test('My test', async ({request}) => {
    await test.step('First step', async () => {
        const health = await request.get(`${baseUrl}/health`)
        expect(health).toBeOK()
    });

    await test.step('Second step', async () => {
        const response = await request.post(`${baseUrl}/health`)
        // Assertions for the second step
        ...
    })
})

Code your API checks

Programmatically code your API monitors in TypeScript or JavaScript. Checkly gives you complete control over all HTTP request options: HTTP method, URL, query parameters, headers, and body. We monitor your APIs as often as every ten seconds.

import { ApiCheck, AssertionBuilder, Frequency } from "@checkly/cli/constructs";

new ApiCheck("public-stats-api", {
  name: "API: Public stats",
  alertChannels: [],
  degradedResponseTime: 10000,
  maxResponseTime: 20000,
  frequency: Frequency.EVERY_30S,
  request: {
    url: "https://api.checklyhq.com/public-stats",
    method: "GET",
    followRedirects: true,
    skipSSL: false,
  },
});

Add API Check Assertions

Monitor your APIs for correct response times, HTTP status codes, plain text or JSON bodies and headers. Drill into JSON payloads with JSON path or user regular expression.

import { ApiCheck, AssertionBuilder, Frequency } from "@checkly/cli/constructs";

new ApiCheck("public-stats-endpoint", {
  name: "API: Public stats",
  alertChannels: [],
  degradedResponseTime: 10000,
  maxResponseTime: 20000,
  frequency: Frequency.EVERY_30S,
  request: {
    url: "https://api.checklyhq.com/public-stats",
    method: "GET",
    followRedirects: true,
    skipSSL: false,
    assertions: [
      // add assertions against status codes, headers and response bodies
      AssertionBuilder.statusCode().equals(200),
      AssertionBuilder.jsonBody("$.apiCheckResults").greaterThan(5000_000_000),
    ],
  },
});

Customize Setup & Teardown

Take complete control of how your request executes. Use setup scripts to cryptographically sign requests, fetch OAuth tokens and update request attributes before any request is done. Use teardown scripts to clean up test data or scrub sensitive data from the response.

import { ApiCheck, AssertionBuilder, Frequency } from "@checkly/cli/constructs";
import * as path from "path";

new ApiCheck("public-stats-endpoint", {
  name: "API: Public stats",
  alertChannels: [],
  degradedResponseTime: 10000,
  maxResponseTime: 20000,
  frequency: Frequency.EVERY_30S,
  request: {
    url: "https://api.checklyhq.com/public-stats",
    method: "GET",
    followRedirects: true,
    skipSSL: false,
    assertions: [
      AssertionBuilder.statusCode().equals(200),
      AssertionBuilder.jsonBody("$.apiCheckResults").greaterThan(5000_000_000),
    ],
  },
  // define setup script
  setupScript: {
    entrypoint: path.join(__dirname, "setup.ts"),
  },
  // define teardown script
  tearDownScript: {
    entrypoint: path.join(__dirname, "teardown.ts"),
  },
});

Test your Future API monitoring

Test your defined API monitors locally or in your CI/CD development work flow to avoid misconfigured or broken monitoring resulting in unnecessary alert.

$ npx checkly test

Running 3 checks in eu-west-1.

src/api/__checks__/api.check.ts
   ✔ API: Public stats (65ms)
   ✔ API: Add to cart (369ms)
   ✔ API: Create order (561ms)

2 passed, 2 total

Deploy your Monitoring infrastructure

Deploy and update your API monitoring resources after successful production deployments.

$ npx checkly deploy --preview

Create: 
    ApiCheck: public-stats-api
    ApiCheck: add-to-card-api
    ApiCheck: create-order-api

$ npx checkly deploy --preview

? You are about to deploy your project "Monitoring as code" to account "Production". 
Do you want to continue? Yes

Successfully deployed project "Monitoring as code" to account "Production".