API Reference

Changedetection.io API

Drive your changedetection.io from other systems with our RESTful API.

Endpoints

http://localhost/api/v1/watch

GET - Get a list of existing watches, append ?recheck_all=1 to force recheck of all

POST - Create a new watch '{"url": "https://my-nice.com", "tag": "optional one, optional two" , "title": "optional title"}'

http://localhost/api/v1/watch/<string:uuid>

GET - Get information about a single watch, excluding the history list (can be large) , append ?recheck=1 to force recheck

DELETE - Delete a single watch by UUID

http://localhost/api/v1/watch/<string:uuid>/history

GET - List all history (timestamps) of watch by UUID

http://localhost/api/v1/watch/<string:uuid>/history/<string:timestamp>

GET - Retrieve a snapshot by timestamp or latest for latest

API Access

A new API key section is added in global config

Always include x-api-key header value if enabled, copy/paste the key from the global settings page