Feeds

Methods to manage RSS feeds added to RSS Automation

Methods

Create

POST /rss/create

Creates an RSS feed with the given parameters. The created feed object is returned.

Parameters

title:Title of the RSS feed as will appear on the site
rss_source_url:The URL of the RSS feed to be watched
parent_dir_id:The file ID of the folder to place the RSS feed files in
delete_old_files:Should old files in the folder be deleted when space is low (default: false)
dont_process_whole_feed:Should the current items in the feed, at creation time, be ignored (default: false)
keyword:Only items with titles that contain any of these words will be transferred (comma-separated list of words, default null)
unwanted_keywords:No items with titles that contain any of these words will be transferred (comma-separated list of words, default null)
paused:Should the RSS feed be created in the paused state. (default false)

Example response:

{
  "status": "OK",
  "feed": {
      "id": "7645645",
      "title": "Test RSS feed",
      "rss_source_url": "http://example.com/feed.rss",
      "parent_dir_id": 0,
      "delete_old_files": false,
      "keyword": null,
      "unwanted_keywords": null,
      "paused": false,
      "paused_at": null,
      "created_at": "2018-10-05T13:58:46",
      "updated_at": "2018-10-05T13:58:46",
      "start_at": "2018-10-05T13:58:46"
  }
}

List

GET /rss/list

Lists RSS feeds.

Example response:

  {
    "feeds": [
        {
            "id": "7645645",
            "title": "Test RSS feed",
            "rss_source_url": "http://example.com/feed.rss",
            "parent_dir_id": 0,
            "delete_old_files": false,
            "keyword": null,
            "unwanted_keywords": null,
            "paused": false,
            "paused_at": null,
            "created_at": "2018-10-05T13:58:46",
            "updated_at": "2018-10-05T13:58:46",
            "start_at": "2018-10-05T13:58:46"
        },
        {
            "id": "7645646",
            "title": "Second RSS feed",
            "rss_source_url": "http://example.com/feed2.rss",
            "parent_dir_id": 10,
            "delete_old_files": true,
            "keyword": null,
            "unwanted_keywords": null,
            "paused": false,
            "paused_at": null,
            "created_at": "2018-10-05T13:58:46",
            "updated_at": "2018-10-05T13:58:46",
            "start_at": "2018-10-05T13:58:46"
        }
    ],
    "status": "OK"
}

Get

GET /rss/<feed_id>

Gives detailed information about the given feed id.

Example response:

{
  "status": "OK",
  "feed": {
      "id": "7645645",
      "title": "Test RSS feed",
      "rss_source_url": "http://example.com/feed.rss",
      "parent_dir_id": 0,
      "delete_old_files": false,
      "keyword": null,
      "unwanted_keywords": null,
      "paused": false,
      "paused_at": null,
      "created_at": "2018-10-05T13:58:46",
      "updated_at": "2018-10-05T13:58:46",
      "start_at": "2018-10-05T13:58:46"
  }
}

Update

POST /rss/<feed_id>

Updates an RSS feed with the given parameters. The updated feed object is returned.

Parameters

title:Title of the RSS feed as will appear on the site
rss_source_url:The URL of the RSS feed to be watched
parent_dir_id:The file ID of the folder to place the RSS feed files in
delete_old_files:Should old files in the folder be deleted when space is low (default: false)
dont_process_whole_feed:Should the current items in the feed, at creation time, be ignored (default: false)
keyword:Only items with titles that contain any of these words will be transferred (comma-separated list of words, default null)
unwanted_keywords:No items with titles that contain any of these words will be transferred (comma-separated list of words, default null)
paused:Should the RSS feed be created in the paused state. (default false)

Example response:

{
  "status": "OK",
  "feed": {
      "id": "7645645",
      "title": "Test RSS feed",
      "rss_source_url": "http://example.com/feed.rss",
      "parent_dir_id": 0,
      "delete_old_files": false,
      "keyword": null,
      "unwanted_keywords": null,
      "paused": false,
      "paused_at": null,
      "created_at": "2018-10-05T13:58:46",
      "updated_at": "2018-10-05T13:58:46",
      "start_at": "2018-10-05T13:58:46"
  }
}

Pause

POST /rss/<feed_id>/pause

Pauses the RSS feed, so that it is not polled for new items anymore.

Example response:

{
  "status": "OK"
}

Resume

POST /rss/<feed_id>/resume

Resumes the RSS feed, so that it starts being polled for new items again.

Example response:

{
  "status": "OK"
}

Delete

POST /rss/<feed_id>/delete

Deletes given RSS feed.

Example response:

{
  "status": "OK"
}