GuardYak Docs

How to monitor an API endpoint in GuardYak

An API can return 200 OK while sending back an error. An API check sends the request you define, with headers and a body if needed, and checks a value in the JSON response, so you hear about an unhealthy service and not only a dead one.

Before you start

  • A GuardYak account (every check type is available on the free plan)

Plays silently with captions; the narrated version is on its way.

Transcript

Go beyond 'is it up' and check the API actually answers correctly. Here's how to monitor an API endpoint in GuardYak.

Start a new check and choose API.

Name the check and paste the endpoint's URL. Then tell GuardYak what a healthy answer looks like: here, the status field must equal OK.

Select Next, then add the email address that should hear about problems.

Select Review, check the summary, and create it. The new check joins your list, and GuardYak starts checking on its next run.

Steps

  1. Choose the check type ▶ 0:09

    In Checks, select + New check, then select API.

    New check page with the API check type highlighted

  2. Fill in the details ▶ 0:12

    Enter a Check name and the endpoint URL. Add Headers (JSON object) or a Request body if the API needs them, then set Assert JSON path (optional) and Expected value at path.

    Configure step for a API check with its fields filled in

  3. Choose who gets alerts ▶ 0:22

    Select Next. Under Address, enter the email that should receive alerts.

    Notify step with an email address entered for alerts

  4. Create the check ▶ 0:28

    Select Review, check the summary, then select Create check. The new check appears on Checks.

    Checks list showing the new Orders API health check
ResultThe check appears on Checks with type API. It fails on the wrong status code or when the JSON value doesn't match.

Next steps

Updated 2026-11-03