API Reference

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.

  • The /roles endpoint lets you enumerate and create custom permissions for accessing collections.

  • The /accounts endpoint enables managing users, teams, and organizations.

  • The /configs endpoint gives you access to the swarm’s configuration.

Learn more about the MKE API at MKE 3.3 API Reference.