How To Use It

Getting Started

Using Kubefeed is simple. The API provides a JSON endpoint that you can query to get information about Kubernetes releases.

API Endpoint

Access the feed at:

/api/feeds/json

Query Parameters

Parameter	Description	Type	Default
draft	Filter by draft status	boolean	false
prerelease	Filter by pre-release status	boolean	false
notes	Include release notes	boolean	false
supported	Filter for supported Kubernetes versions (latest 3 minor releases)	boolean	false
latest	When used with supported, returns only the latest patch release for each supported minor version. If prerelease is also set, it will include the latest pre-release as well.	boolean	false
before	Filter for releases before a specific date (YYYYMMDD). Can be used in conjunction with the after parameter to get releases between a set of dates.	string	null
after	Filter for releases after a specific date (YYYYMMDD). Can be used in conjunction with the before parameter to get releases between a set of dates.	string	null

Example Usage

Fetch all stable releases:

GET /api/feeds/json

Fetch stable releases including drafts and pre-releases):

GET /api/feeds/json?draft=true&prerelease=true

Fetch releases including release notes:

GET /api/feeds/json?notes=true

Fetch releases before a specific date:

GET /api/feeds/json?before=20240101

Fetch releases after a specific date:

GET /api/feeds/json?after=20230101

Fetch releases between two dates:

GET /api/feeds/json?after=20230101&before=20231231

Fetch currently supported releases:

GET /api/feeds/json?supported=true

Get latest supported releases

GET /api/feeds/json?supported=true&latest=true

Get latest supported releases including prereleases

GET /api/feeds/json?supported=true&latest=true&prerelease=true

Want To Experiment?

Kubefeed provides a Swagger UI where you can start playing around with the different parameters. Take any of the above examples you're interested in and give them a whirl here