API Reference Updated

Warning

In correlation with the end of life (EOL) date for MKE 3.3.x, Mirantis stopped maintaining this documentation version as of 2022-05-27. The latest MKE product documentation is available here.

The Mirantis Kubernetes Engine (MKE) API is a REST API, available using HTTPS, that enables programmatic access to Swarm resources managed by MKE. MKE exposes the full Mirantis Container Runtime API, so you can extend your existing code with MKE features. The API is secured with role-based access control so that only authorized users can make changes and deploy applications to your Docker swarm.

The MKE API is accessible in the same IP addresses and domain names that you use to access the web UI. It is the same API that the MKE web UI uses, so everything you can do on the MKE web UI from your browser, you can also do programmatically.

The system manages Swarm resources by using collections, which you access through the /collection endpoint. For example, GET /defaultCollection/ retrieves the default collection for a user.

endpoint	Description
/roles	Allows you to enumerate and create custom permissions for accessing collections.
/accounts	Enables the management of users, teams, and organizations.
/configs	Provides access to the swarm configuration.

• MKE 3.3.17 API Reference

• MKE 3.3.16 API Reference

• MKE 3.3.15 API Reference

• MKE 3.3.14 API Reference

• MKE 3.3.13 API Reference

• MKE 3.3.12 API Reference

• MKE 3.3.11 API Reference

• MKE 3.3.10 API Reference (discontinued)

• MKE 3.3.9 API Reference

• MKE 3.3.8 API Reference

• MKE 3.3.7 API Reference

• MKE 3.3.6 API Reference

• MKE 3.3.5 API Reference

• MKE 3.3.4 API Reference

• MKE 3.3.3 API Reference

• MKE 3.3.2 API Reference

• MKE 3.3.1 API Reference

• MKE 3.3.0 API Reference