diff --git a/docs/api_v1/index.html b/docs/api_v1/index.html index e5c399d7c..4f1bc4e2a 100644 --- a/docs/api_v1/index.html +++ b/docs/api_v1/index.html @@ -432,7 +432,7 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/ -
API docs by Redocly
API docs by Redocly

Core functionality for managing web page monitors. Create, retrieve, update, and delete individual watches. Each watch represents a single URL being monitored for changes, with configurable settings for check intervals, notification preferences, and content filtering options.

-

List all watches

Return concise list of available watches and basic info

+

List all watches

Return concise list of available web page change monitors (watches) and basic info

Authorizations:
ApiKeyAuth
query Parameters
recheck_all
string
Value: "1"

Set to 1 to force recheck of all watches

tag
string

Custom server

{protocol}://{host}/api/v1/watch

Request samples 

curl -X GET "http://localhost:5000/api/v1/watch" \
   -H "x-api-key: YOUR_API_KEY"
-

Response samples

Content type
application/json
{
  • "095be615-a8ad-4c33-8e9c-c7612fbf6c9f": {
    },
  • "7c9e6b8d-f2a1-4e5c-9d3b-8a7f6e4c2d1a": {
    }
}

Create a new watch

Create a single watch. Requires at least 'url' to be set.

+

Response samples

Content type
application/json
{
  • "095be615-a8ad-4c33-8e9c-c7612fbf6c9f": {
    },
  • "7c9e6b8d-f2a1-4e5c-9d3b-8a7f6e4c2d1a": {
    }
}

Create a new watch

Create a single web page change monitor (watch). Requires at least 'url' to be set.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
url
required
string <uri> <= 5000 characters

URL to monitor for changes

-
title
string <= 5000 characters

Custom title for the watch

-
tag
string <= 5000 characters

Tag UUID to associate with this watch

+
title
string <= 5000 characters

Custom title for the web page change monitor (watch)

+
tag
string <= 5000 characters

Tag UUID to associate with this web page change monitor (watch)

tags
Array of strings

Array of tag UUIDs

-
paused
boolean

Whether the watch is paused

+
paused
boolean

Whether the web page change monitor (watch) is paused

muted
boolean

Whether notifications are muted

method
string
Enum: "GET" "POST" "DELETE" "PUT"

JavaScript code to execute

object

Time intervals between checks

-
notification_urls
Array of strings

Notification URLs for this watch

+
notification_urls
Array of strings

Notification URLs for this web page change monitor (watch)

notification_title
string <= 5000 characters

Custom notification title

notification_body
string <= 5000 characters

Whether to track JSON-LD price data

Array of objects

Browser automation steps

-

Responses

Responses

Request samples

Content type
application/json
{
  • "url": "https://example.com",
  • "title": "Example Site Monitor",
  • "time_between_check": {
    }
}

Get single watch

Retrieve watch information and set muted/paused status. Returns the FULL Watch JSON.

-
Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>

Watch unique ID

-
query Parameters
recheck
string
Enum: "1" "true"

Recheck this watch

+
{protocol}://{host}/api/v1/watch

Request samples

Content type
application/json
{
  • "url": "https://example.com",
  • "title": "Example Site Monitor",
  • "time_between_check": {
    }
}

Get single watch

Retrieve web page change monitor (watch) information and set muted/paused status. Returns the FULL Watch JSON.

+
Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>

Web page change monitor (watch) unique ID

+
query Parameters
recheck
string
Enum: "1" "true"

Recheck this web page change monitor (watch)

paused
string
Enum: "paused" "unpaused"

Set pause state

muted
string
Enum: "muted" "unmuted"

Set mute state

Responses

Request samples 

curl -X GET "http://localhost:5000/api/v1/watch/095be615-a8ad-4c33-8e9c-c7612fbf6c9f" \
   -H "x-api-key: YOUR_API_KEY"
-

Response samples

Content type
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "url": "http://example.com",
  • "title": "string",
  • "tag": "string",
  • "tags": [
    ],
  • "paused": true,
  • "muted": true,
  • "method": "GET",
  • "fetch_backend": "html_requests",
  • "headers": {
    },
  • "body": "string",
  • "proxy": "string",
  • "webdriver_delay": 0,
  • "webdriver_js_execute_code": "string",
  • "time_between_check": {
    },
  • "notification_urls": [
    ],
  • "notification_title": "string",
  • "notification_body": "string",
  • "notification_format": "Text",
  • "track_ldjson_price_data": true,
  • "browser_steps": [
    ],
  • "last_checked": 0,
  • "last_changed": 0,
  • "last_error": "string"
}

Update watch

Update an existing watch using JSON. Accepts the same structure as returned in get single watch information.

-
Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>

Watch unique ID

+

Response samples

Content type
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "url": "http://example.com",
  • "title": "string",
  • "tag": "string",
  • "tags": [
    ],
  • "paused": true,
  • "muted": true,
  • "method": "GET",
  • "fetch_backend": "html_requests",
  • "headers": {
    },
  • "body": "string",
  • "proxy": "string",
  • "webdriver_delay": 0,
  • "webdriver_js_execute_code": "string",
  • "time_between_check": {
    },
  • "notification_urls": [
    ],
  • "notification_title": "string",
  • "notification_body": "string",
  • "notification_format": "Text",
  • "track_ldjson_price_data": true,
  • "browser_steps": [
    ],
  • "last_checked": 0,
  • "last_changed": 0,
  • "last_error": "string"
}

Update watch

Update an existing web page change monitor (watch) using JSON. Accepts the same structure as returned in get single watch information.

+
Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>

Web page change monitor (watch) unique ID

Request Body schema: application/json
required
url
required
string <uri> <= 5000 characters

URL to monitor for changes

-
title
string <= 5000 characters

Custom title for the watch

-
tag
string <= 5000 characters

Tag UUID to associate with this watch

+
title
string <= 5000 characters

Custom title for the web page change monitor (watch)

+
tag
string <= 5000 characters

Tag UUID to associate with this web page change monitor (watch)

tags
Array of strings

Array of tag UUIDs

-
paused
boolean

Whether the watch is paused

+
paused
boolean

Whether the web page change monitor (watch) is paused

muted
boolean

Whether notifications are muted

method
string
Enum: "GET" "POST" "DELETE" "PUT"

JavaScript code to execute

object

Time intervals between checks

-
notification_urls
Array of strings

Notification URLs for this watch

+
notification_urls
Array of strings

Notification URLs for this web page change monitor (watch)

notification_title
string <= 5000 characters

Custom notification title

notification_body
string <= 5000 characters

Whether to track JSON-LD price data

Array of objects

Browser automation steps

-

Responses

Responses

Request samples

Content type
application/json
{
  • "url": "http://example.com",
  • "title": "string",
  • "tag": "string",
  • "tags": [
    ],
  • "paused": true,
  • "muted": true,
  • "method": "GET",
  • "fetch_backend": "html_requests",
  • "headers": {
    },
  • "body": "string",
  • "proxy": "string",
  • "webdriver_delay": 0,
  • "webdriver_js_execute_code": "string",
  • "time_between_check": {
    },
  • "notification_urls": [
    ],
  • "notification_title": "string",
  • "notification_body": "string",
  • "notification_format": "Text",
  • "track_ldjson_price_data": true,
  • "browser_steps": [
    ]
}

Delete watch

Delete a watch and all related history

-
Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>

Watch unique ID

-

Responses

Request samples

Content type
application/json
{
  • "url": "http://example.com",
  • "title": "string",
  • "tag": "string",
  • "tags": [
    ],
  • "paused": true,
  • "muted": true,
  • "method": "GET",
  • "fetch_backend": "html_requests",
  • "headers": {
    },
  • "body": "string",
  • "proxy": "string",
  • "webdriver_delay": 0,
  • "webdriver_js_execute_code": "string",
  • "time_between_check": {
    },
  • "notification_urls": [
    ],
  • "notification_title": "string",
  • "notification_body": "string",
  • "notification_format": "Text",
  • "track_ldjson_price_data": true,
  • "browser_steps": [
    ]
}

Delete watch

Delete a web page change monitor (watch) and all related history

+
Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>

Web page change monitor (watch) unique ID

+

Responses

Get watch history

Get a list of all historical snapshots available for a watch

-
Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>

Watch unique ID

+

Get watch history

Get a list of all historical snapshots available for a web page change monitor (watch)

+
Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>

Web page change monitor (watch) unique ID

Responses

Get single snapshot

Get single snapshot from watch. Use 'latest' for the most recent snapshot.

-
Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>

Watch unique ID

+

Get single snapshot

Get single snapshot from web page change monitor (watch). Use 'latest' for the most recent snapshot.

+
Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>

Web page change monitor (watch) unique ID

required
integer or string

Snapshot timestamp or 'latest'

query Parameters
html
string
Value: "1"

Retrieve favicon images associated with monitored web pages. These are used in the dashboard interface to visually identify different watches in your monitoring list.

-

Get watch favicon

Get the favicon for a watch as displayed in the watch overview list.

-
Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>

Watch unique ID

+

Get watch favicon

Get the favicon for a web page change monitor (watch) as displayed in the watch overview list.

+
Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>

Web page change monitor (watch) unique ID

Responses

List all tags

List all tags

Return list of available tags/groups

Authorizations:
ApiKeyAuth

Responses

Request samples 

curl -X GET "http://localhost:5000/api/v1/tags" \
   -H "x-api-key: YOUR_API_KEY"
-

Response samples

Content type
application/json
{
  • "550e8400-e29b-41d4-a716-446655440000": {
    },
  • "330e8400-e29b-41d4-a716-446655440001": {
    }
}

Get single tag

Retrieve tag information, set notification_muted status, recheck all in tag.

+

Response samples

Content type
application/json
{
  • "550e8400-e29b-41d4-a716-446655440000": {
    },
  • "330e8400-e29b-41d4-a716-446655440001": {
    }
}

Create tag

Create a single tag/group

+
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
title
required
string <= 5000 characters

Tag title

+
notification_urls
Array of strings

Default notification URLs for web page change monitors (watches) with this tag

+
notification_muted
boolean

Whether notifications are muted for this tag

+

Responses

Request samples

Content type
application/json
{
  • "title": "Important Sites"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Get single tag

Retrieve tag information, set notification_muted status, recheck all web page change monitors (watches) in tag.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>

Tag unique ID

query Parameters
muted
string
Enum: "muted" "unmuted"

Set mute state

-
recheck
string
Value: "true"

Queue all watches with this tag for recheck

+
recheck
string
Value: "true"

Queue all web page change monitors (watches) with this tag for recheck

Responses

Custom server

-
{protocol}://{host}/api/v1/tag/{uuid}

Request samples 

curl -X GET "http://localhost:5000/api/v1/tag/550e8400-e29b-41d4-a716-446655440000" \
+
{protocol}://{host}/api/v1/tag/{uuid}

Request samples 

curl -X GET "http://localhost:5000/api/v1/tag/550e8400-e29b-41d4-a716-446655440000" \
   -H "x-api-key: YOUR_API_KEY"
-

Response samples

Content type
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "title": "string",
  • "notification_urls": [
    ],
  • "notification_muted": true
}

Update tag

Response samples

Content type
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "title": "string",
  • "notification_urls": [
    ],
  • "notification_muted": true
}

Update tag

Update an existing tag using JSON

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>

Tag unique ID

Request Body schema: application/json
required
title
required
string <= 5000 characters

Tag title

-
notification_urls
Array of strings

Default notification URLs for watches with this tag

+
notification_urls
Array of strings

Default notification URLs for web page change monitors (watches) with this tag

notification_muted
boolean

Whether notifications are muted for this tag

Responses

Custom server

-
{protocol}://{host}/api/v1/tag/{uuid}

Request samples

Content type
application/json
{
  • "title": "string",
  • "notification_urls": [
    ],
  • "notification_muted": true
}

Delete tag

Delete a tag/group and remove it from all watches

+
{protocol}://{host}/api/v1/tag/{uuid}

Request samples

Content type
application/json
{
  • "title": "string",
  • "notification_urls": [
    ],
  • "notification_muted": true
}

Delete tag

Delete a tag/group and remove it from all web page change monitors (watches)

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>

Tag unique ID

Responses

Custom server

-
{protocol}://{host}/api/v1/tag/{uuid}

Request samples 

curl -X DELETE "http://localhost:5000/api/v1/tag/550e8400-e29b-41d4-a716-446655440000" \
+
{protocol}://{host}/api/v1/tag/{uuid}

Request samples 

curl -X DELETE "http://localhost:5000/api/v1/tag/550e8400-e29b-41d4-a716-446655440000" \
   -H "x-api-key: YOUR_API_KEY"
-

Create tag

Create a single tag/group

-
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
title
required
string <= 5000 characters

Tag title

-
notification_urls
Array of strings

Default notification URLs for watches with this tag

-
notification_muted
boolean

Whether notifications are muted for this tag

-

Responses

Request samples

Content type
application/json
{
  • "title": "Important Sites"
}

Notifications

Notifications

https://github.com/caronc/apprise.

-

Get notification URLs

Get notification URLs

Return the notification URL list from the configuration

Authorizations:
ApiKeyAuth

Responses

Request samples 

curl -X GET "http://localhost:5000/api/v1/notifications" \
   -H "x-api-key: YOUR_API_KEY"
-

Response samples

Content type
application/json
{}

Add notification URLs

Response samples

Content type
application/json
{}

Add notification URLs

Add one or more notification URLs to the configuration

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
notification_urls
required
Array of strings <uri> [ items <uri > ]

List of notification URLs

@@ -819,7 +819,7 @@ These settings serve as defaults that can be overridden at the individual watch " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">

Production server

https://yourdomain.com/api/v1/notifications

Custom server

-
{protocol}://{host}/api/v1/notifications

Request samples

Content type
application/json
{
  • "notification_urls": [
    ]
}

Response samples

Content type
application/json
{}

Replace notification URLs

{protocol}://{host}/api/v1/notifications

Request samples

Content type
application/json
{
  • "notification_urls": [
    ]
}

Response samples

Content type
application/json
{}

Replace notification URLs

Replace all notification URLs with the provided list (can be empty)

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
notification_urls
required
Array of strings <uri> [ items <uri > ]

List of notification URLs

@@ -833,7 +833,7 @@ These settings serve as defaults that can be overridden at the individual watch " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">

Production server

https://yourdomain.com/api/v1/notifications

Custom server

-
{protocol}://{host}/api/v1/notifications

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Delete notification URLs

{protocol}://{host}/api/v1/notifications

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Delete notification URLs

Delete one or more notification URLs from the configuration

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
notification_urls
required
Array of strings <uri> [ items <uri > ]

List of notification URLs

@@ -851,8 +851,8 @@ These settings serve as defaults that can be overridden at the individual watch monitors in large collections or identifying watches that match certain criteria.</p> ">

Search and filter your watches by URL patterns, titles, or tags. Useful for quickly finding specific monitors in large collections or identifying watches that match certain criteria.

-

Search watches

Search watches by URL or title text

+

Search watches

Search web page change monitors (watches) by URL or title text

Authorizations:
ApiKeyAuth
query Parameters
q
required
string

Search query to match against watch URLs and titles

tag
string

Bulk import multiple URLs for monitoring. Accepts plain text lists of URLs and can automatically apply tags, proxy settings, and other configurations to all imported watches simultaneously.

-

Import watch URLs

Import watch URLs

Import a list of URLs to monitor. Accepts line-separated URLs in request body.

-
Authorizations:
ApiKeyAuth
query Parameters
tag_uuids
string

Tag UUID to apply to imported watches

-
tag
string

Tag name to apply to imported watches

-
proxy
string

Proxy key to use for imported watches

+
Authorizations:
ApiKeyAuth
query Parameters
tag_uuids
string

Tag UUID to apply to imported web page change monitors (watches)

+
tag
string

Tag name to apply to imported web page change monitors (watches)

+
proxy
string

Proxy key to use for imported web page change monitors (watches)

dedupe
boolean
Default: true

Remove duplicate URLs (default true)

Request Body schema: text/plain
required
string

Responses

Get system information

Get system information

Return information about the current system state

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "watch_count": 42,
  • "tag_count": 5,
  • "uptime": "2 days, 3:45:12",
  • "version": "0.50.10"
}