Monitors

List monitors

GET /api/v1/monitors

Returns all monitored APIs for the authenticated user.

Query parameters

Parameter	Type	Description
`status`	string	Filter by status: `active`, `paused`, `error`

Response

{
  "data": [
    {
      "id": "uuid",
      "name": "Stripe API",
      "docs_url": "https://docs.stripe.com/api",
      "status": "active",
      "scan_frequency": "daily",
      "health_score": 92,
      "catalog_api": {
        "slug": "stripe",
        "name": "Stripe",
        "logo_url": "/logos/stripe.svg"
      },
      "created_at": "2026-01-15T10:00:00Z"
    }
  ]
}

Create monitor

POST /api/v1/monitors

Requires Pro plan.

Add a new API to monitor. Provide either a catalog_api_slug for a pre-configured API, or a docs_url for a custom API.

Request body

Field	Type	Required	Description
`catalog_api_slug`	string	One of these	Slug from the catalog (e.g., `stripe`)
`docs_url`	string	required	URL of API documentation for custom monitoring
`openapi_spec_url`	string	—	OpenAPI spec URL (optional, for custom APIs)

Example

curl -X POST https://api.varen.dev/v1/monitors \
  -H "Authorization: Bearer vk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"catalog_api_slug": "stripe"}'

Get monitor

GET /api/v1/monitors/:id

Returns detailed information about a specific monitor.

Update monitor

PATCH /api/v1/monitors/:id

Requires Pro plan.

Request body

Field	Type	Description
`status`	string	`active` or `paused`
`scan_frequency`	string	`hourly` or `daily`
`alert_on_breaking`	boolean	Alert on breaking changes
`alert_on_deprecation`	boolean	Alert on deprecations
`alert_on_non_breaking`	boolean	Alert on non-breaking changes

Delete monitor

DELETE /api/v1/monitors/:id

Requires Pro plan.

Trigger scan

POST /api/v1/monitors/:id/check

Requires Pro plan. Rate limited to 3 per minute.

Triggers an immediate scan of the monitored API. Returns 202 Accepted.

On this page