OpenAPI Change Monitor avatar

OpenAPI Change Monitor

Pricing

Pay per usage

Go to Apify Store
OpenAPI Change Monitor

OpenAPI Change Monitor

Monitor OpenAPI JSON/YAML specifications and output structured breaking/non-breaking API change records.

Pricing

Pay per usage

Rating

0.0

(0)

Developer

Prophed Com

Prophed Com

Maintained by Community

Actor stats

0

Bookmarked

2

Total users

1

Monthly active users

39 minutes ago

Last modified

Categories

Share

Monitor public OpenAPI JSON/YAML specifications and receive structured change records in an Apify dataset.

Why use it

API consumers, integration teams, developer-tool vendors, and automation teams need early warning when an API surface changes. This Actor turns OpenAPI specs into scheduled, dataset-friendly change records that can feed alerts, QA checks, dashboards, and integration maintenance workflows.

What it detects

  • Added operations
  • Removed operations
  • Changed operations
  • Added required parameters
  • Removed response codes
  • Request content-type changes
  • Fetch and parse errors
  • Optional unchanged/baseline rows

Input

{
"specs": [
{
"name": "APIs.guru",
"url": "https://api.apis.guru/v2/specs/apis.guru/2.2.0/openapi.json"
}
],
"includeUnchanged": false,
"storeBaseline": true,
"compareKeyPrefix": "openapi-change-monitor",
"maxSpecs": 25
}

Output

Each dataset item is one finding:

{
"specName": "Example API",
"specUrl": "https://example.com/openapi.json",
"changeType": "changed",
"severity": "breaking",
"method": "GET",
"path": "/users",
"operationId": "listUsers",
"details": {
"addedRequiredParameters": ["query:tenant"],
"removedResponses": ["200"],
"requestContentTypesChanged": false
},
"detectedAt": "2026-07-05T00:00:00.000Z"
}

Typical workflows

  • Schedule a daily run for public partner APIs.
  • Send breaking-change rows to Slack, email, Zapier, Make, or a webhook.
  • Keep a baseline in the Actor key-value store and compare each new run against it.
  • Monitor multiple specs in one batch while keeping maxSpecs capped for cost control.

Notes

This Actor only processes spec URLs supplied by the user. Users are responsible for permission to monitor any private or non-public specification URL they provide.