API Reference
Changes
Query detected API documentation changes.
List changes
GET /api/v1/changesReturns changes detected across your monitored APIs, newest first.
Query parameters
| Parameter | Type | Description |
|---|---|---|
api_id | string | Filter by monitor UUID |
classification | string | Filter by classification: BREAKING, DEPRECATION, NEW_FEATURE, BUG_FIX, SECURITY, PERFORMANCE, COSMETIC |
severity | string | Filter by severity: critical, warning, info |
since | string | ISO 8601 timestamp — only changes after this date |
until | string | ISO 8601 timestamp — only changes before this date |
page | integer | Page number (default: 1) |
per_page | integer | Results per page (default: 20, max: 100) |
Example
curl "https://api.varen.dev/v1/changes?severity=critical&since=2026-03-01T00:00:00Z" \
-H "Authorization: Bearer vk_your_key"Response
{
"data": [
{
"id": "b3f1a2c4-5d6e-7f89-0a1b-2c3d4e5f6789",
"api_id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
"api_name": "Stripe API",
"change_type": "endpoint_removed",
"classification": "BREAKING",
"severity": "critical",
"endpoint": "POST /v1/charges",
"description": "The /v1/charges endpoint has been removed. Use /v1/payment_intents instead.",
"before_value": "POST /v1/charges — Create a charge",
"after_value": null,
"detected_at": "2026-03-15T14:30:00Z"
}
],
"meta": {
"total": 156,
"page": 1,
"per_page": 20
}
}Get change
GET /api/v1/changes/:idReturns full detail for a single change, including AI analysis and migration guides (when available).
Response
{
"data": {
"id": "b3f1a2c4-5d6e-7f89-0a1b-2c3d4e5f6789",
"api_id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
"api_name": "Stripe API",
"change_type": "endpoint_removed",
"classification": "BREAKING",
"severity": "critical",
"endpoint": "POST /v1/charges",
"description": "The /v1/charges endpoint has been removed. Use /v1/payment_intents instead.",
"before_value": "POST /v1/charges — Create a charge",
"after_value": null,
"ai_analysis": "The Charges API has been fully deprecated in favor of Payment Intents. All integrations using POST /v1/charges must migrate to POST /v1/payment_intents. The Payment Intents API supports SCA and multi-step payment flows.",
"migration_guides": [
{
"type": "official",
"title": "Migrating from Charges to Payment Intents",
"url": "https://stripe.com/docs/payments/payment-intents/migration/charges",
"source": "stripe.com",
"snippet": "Replace your Charges integration with Payment Intents to benefit from SCA support and improved error handling."
}
],
"detected_at": "2026-03-15T14:30:00Z"
}
}ai_analysis and migration_guides are only populated for breaking changes and deprecations.