API Monitoring

API Monitoring is a standalone service in VendorGate that checks the health and behavior of remote endpoints. It is independent of pipelines and transformations, so you can monitor any API your business depends on.

What API Monitoring does

API monitors periodically send requests to an endpoint and evaluate the response. You can check:

• HTTP status code
• Response time
• Response body content, regex, or JSON path
• Expected headers
• TLS certificate expiry

Monitors support OAuth2 client credentials, mTLS, bearer tokens, basic auth, query-param, and header-based API credential authentication.

When to use it

Use API Monitoring when:

• A vendor provides data via an API rather than files.
• You want to know if an endpoint is slow or down before a scheduled pipeline fails.
• You need an audit trail of endpoint availability and performance.

Creating a monitor

1. Go to API Monitoring.
2. Click New Monitor.
3. Enter the endpoint URL and HTTP method.
4. Select the credential if the endpoint requires authentication.
5. Set the schedule, for example every minute or every hour.
6. Define the expected response.
7. Configure alert rules.

Expected response

The expected response configuration tells VendorGate what a healthy response looks like. You can combine multiple checks:

• Status code must equal 200.
• Response time must be under 2000 ms.
• Body must contain a specific string.
• Body JSON must have a path that equals an expected value.
• TLS certificate must not expire within a given number of days.

Alerts

When a check fails, VendorGate can notify your team via email or webhook. You can configure different alert rules for down, degraded, and recovery states.

Monitoring vs. pipelines

API Monitoring is not a replacement for pipelines. Pipelines move and process data. API Monitoring watches endpoints. A single vendor integration may use both: a monitor to watch the vendor API and a pipeline to fetch and process its data.