Watches

Create or update a watch

POST /v1/watches accepts one of two request shapes.

Existing entity
New direct monitor

Reference an entity already visible to the workspace.

{
  "entity_id": "8c221ea2-f921-43e9-8b28-e172013b6aa4",
  "config": {
    "min_severity": "high"
  }
}

Describe a new monitor with a canonical name, source type, and locator.

{
  "canonical_name": "Payments API",
  "entity_type": "api_provider",
  "source_type": "openapi_spec",
  "locator": {
    "url": "https://api.example.com/openapi.json"
  },
  "fetch_interval": "1 hour",
  "active": true
}

Do not combine entity_id with a new monitor descriptor.

Response

{
  "id": "d04c2de9-5a36-487f-91c1-e781f17559a6",
  "entity_id": "8c221ea2-f921-43e9-8b28-e172013b6aa4",
  "source_id": "b8be4811-0abf-4680-83bc-c5b57eb6a681",
  "config": {}
}

Update configuration

PATCH /v1/watches/{watch_id} replaces the watch’s configuration object:

{
  "config": {
    "min_severity": "breaking",
    "signal_types": ["api_change", "docs_deprecation"]
  }
}

Both endpoints require write scope.

Essentials

REST v1

Create or update a watch

Response

Update configuration

​Create or update a watch

​Response

​Update configuration

Create or update a watch

Response

Update configuration