API Reference

API ReferenceΒΆ


This section is intended only for advanced Infrastructure Operators who are familiar with Kubernetes Cluster API.

Mirantis currently supports only those Mirantis Container Cloud API features that are implemented in the Container Cloud web UI. Use other Container Cloud API features for testing and evaluation purposes only.

The Container Cloud APIs are implemented using the Kubernetes CustomResourceDefinitions (CRDs) that enable you to expand the Kubernetes API. Different types of resources are grouped in the dedicated files, such as cluster.yaml or machines.yaml.

This section contains descriptions and examples of the Container Cloud API resources for the OpenStack, AWS, and bare metal cloud providers.


The API documentation for the Equinix Metal and VMware vSphere resources will be added in the upcoming Container Cloud releases.