Creating a monitor

API monitors check remote endpoints on a schedule and alert you when something is wrong. They are independent of pipelines.

Define the endpoint

1. Go to API Monitoring.
2. Click New Monitor.
3. Enter the endpoint URL.
4. Select the HTTP method, such as GET or POST.
5. Choose a credential if the endpoint requires authentication. Monitors support OAuth2 client credentials, mTLS, bearer tokens, basic auth, query-param, and header-based API credential authentication.
6. Set timeout_seconds (1–300 seconds), custom headers, request body, and whether to follow redirects or verify SSL.
7. Optionally use {{ run_id }} and {{ timestamp }} placeholders in the URL, headers, or body.

Set the schedule

Monitors run on a cron schedule. Common examples include every minute, every five minutes, or once per hour. Choose a frequency that matches how critical the endpoint is.

Configure retries

You can configure the monitor to retry a failed check up to three times before marking it as a failure. Retries default to 0; set a value from 0 to 3 to reduce noise from transient network issues.

Save and test

After saving, run a manual check to confirm the monitor reaches the endpoint and receives the response you expect. Review the check result for status code, response time, and any failures.

Organizing monitors

Use clear names that describe the endpoint and its purpose, such as Supplier A Purchase Order API. This makes alerts and run history easier to understand.