RSS API

INTRO

API documentation of https://foutaise.org/rss/

GET https://foutaise.org/rss/api/v1/help

Display this API documentation.

Response

text/html

GET https://foutaise.org/rss/api/v1/feeds

List RSS feeds.

Request header

Authorization (required)

The Authorization header must start with Apikey, followed by the user's API Key.

Response

application/json: array of objects with the following properties

    {
        id:          uint,
        link:        string,
        feedlink:    string,
        title:       string,
        description: string
    }

Example

    curl -H "Authorization: Apikey <your-api-key>" \
        https://foutaise.org/rss/api/v1/feeds

POST https://foutaise.org/rss/api/v1/feeds

Add a RSS feed.

Request header

Authorization (required)

The Authorization header must start with Apikey, followed by the user's API Key.

Request data

feedlink: string (required)

URL of the rss feed to add.

Example

    curl -H "Authorization: Apikey <your-api-key>" \
        -X POST \
        https://foutaise.org/rss/api/v1/feeds \
        -d "feedlink=<new-feed-link>"

DELETE https://foutaise.org/rss/api/v1/feeds/{id}

Delete a RSS feed.

Request header

Authorization (required)

The Authorization header must start with Apikey, followed by the user's API Key.

URI parameter

id: uint (required)

Id of the feed to delete.

Example

    curl -H "Authorization: Apikey <your-api-key>" \
        -X DELETE \
        https://foutaise.org/rss/api/v1/feeds/{id}

GET https://foutaise.org/rss/api/v1/feeds/broken

List broken RSS feeds.

Request header

Authorization (required)

The Authorization header must start with Apikey, followed by the user's API Key.

Response

application/json: array of objects with the following properties

    {
        id:          uint,
        link:        string,
        feedlink:    string,
        title:       string,
        description: string
    }

Example

    curl -H "Authorization: Apikey <your-api-key>" \
        https://foutaise.org/rss/api/v1/feeds/broken

GET https://foutaise.org/rss/api/v1/feeds/refresh

Refresh RSS feeds items in the database.

Request header

Authorization (required)

The Authorization header must start with Apikey, followed by the user's API Key.

Response

application/json: array of objects with the following properties

    {
        feedid:      uint,
        guid:        string,
        link:        string,
        title:       string,
        published:   string,
        description: string
    }

Example

    curl -H "Authorization: Apikey <your-api-key>" \
        https://foutaise.org/rss/api/v1/items/refresh

GET https://foutaise.org/rss/api/v1/items

List unread RSS items.

Request header

Authorization (required)

The Authorization header must start with Apikey, followed by the user's API Key.

Response

application/json: array of objects with the following properties

    {
        feedid:      uint,
        guid:        string,
        link:        string,
        title:       string,
        published:   string,
        description: string
    }

Example

    curl -H "Authorization: Apikey <your-api-key>" \
        https://foutaise.org/rss/api/v1/items

GET https://foutaise.org/rss/api/v1/items/markread

Mark unread RSS items as read.

Request header

Authorization (required)

The Authorization header must start with Apikey, followed by the user's API Key.

Example

    curl -H "Authorization: Apikey <your-api-key>" \
        https://foutaise.org/rss/api/v1/items/markread