Dashboards

Read an RSS feed

GET/dashboards/rss-feed
dashboards:readget_dashboard_rss_feedRead-only

Fetches a public RSS or Atom feed and returns its newest items, ordered by date as the platform's own news widget shows them, for the news widget of a dashboard. url must be an https address on a public host: anything else, including an internal address, returns 422. A feed that cannot be fetched, answers with an error or a redirect, is over 1 MiB, or is not a feed returns 502 upstream_error. url must use port 443. limit defaults to 25, a number over 100 counts as 100, and anything that is not a whole number returns 422. Nothing is cached. It changes nothing here.

Query parameters

  • urlstring (uri)Required#

    The https address of the feed.

  • limitinteger#

    How many items to return, from 1 to 100. Defaults to 25; a larger number counts as 100.

    Default: 25

Responses

200

The feed's items.

DashboardRssFeed
{
  "data": {
    "items": [
      {}
    ]
  },
  "meta": {}
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error
502

An upstream dependency (e.g. Sumsub) was unavailable (error.code = upstream_error).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/dashboards/rss-feed?url={url}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"