OneKS API

The OpenNebula OneKS API is a RESTful service for managing Kubernetes infrastructure on OpenNebula. It allows users to create and manage Kubernetes clusters, operate nodegroups, retrieve cluster information, and trigger lifecycle actions such as scaling and upgrades. All data is sent and received in JSON format.

This guide is intended for developers and integrators. For other purposes, OneKS is accessible via its own OneKS Command Line Interface.

API Authentication

User authentication is based on HTTP Basic access authentication. The required credentials are the username and password.

curl -u "username:password" http://oneks.example.server:10780/api/v1/clusters

By default, the OneKS API listens at http://localhost:10780. Customize this value along with other API service settings in the /etc/one/oneks-server.conf file. For more information, refer to the OneKS Configuration guide.

API Methods

Base URL: http://oneks.example.server:10780/api/v1