Accessing the OpenAPI Specification for a Kubernetes Cluster

· Updated · 1 min read · CC-BY-NC-SA-4.0 Apache-2.0

I'm a big fan of working with OpenAPI specifications, and while working with Kubernetes APIs today I wanted to check what the API expected.

Fortunately, Kubernetes produces the cluster's supported OpenAPI at the /openapi/v2 URL, which means that using Jonny Langefeld's post we can use kubectl proxy to port-forward, and then grab a copy of the OpenAPI:

kubectl proxy --port=8080
curl localhost:8080/openapi/v2 > openapi.json

This can then be used with your favourite OpenAPI viewer, such as a local-only, client-side viewer to give you handy API documentation.

Written by Jamie Tanna's profile image Jamie Tanna on , and last updated on .

Content for this article is shared under the terms of the Creative Commons Attribution Non Commercial Share Alike 4.0 International, and code is shared under the Apache License 2.0.

#blogumentation #kubernetes #openapi.

This blog post is 100% human-written, and has nothing derived from LLMs (be it code, editorial support or prose).

Also on:

This post was filed under articles.

Interactions with this post

Interactions with this post

Below you can find the interactions that this page has had using WebMention.

Have you written a response to this post? Let me know the URL:

Do you not have a website set up with WebMention capabilities? You can use Comment Parade.