Cloudera Manager API Compatibility Matrix

This document provides the Cloudera Manager API Compatibility Matrix to ensure seamless communication between automated clients and the Cloudera Manager server. This matrix defines the required Python environments and minimum Cloudera Manager versions necessary for specific API client versions and REST endpoints to function correctly.

To maintain system stability and avoid breaking changes, Cloudera Manager enforces strict versioning for its API clients and REST interfaces. This compatibility framework allows administrators to upgrade Cloudera Manager while understanding the impact on existing automation scripts and custom integrations.

  • Python Support: Each cm-client version requires a specific Python runtime to execute successfully.

  • Version Alignment: Upgrading to a newer REST API version (for example, v57 to v58) typically requires a corresponding minimum Cloudera Manager backend version to support the newer features and data structures.

  • Backward Compatibility: While newer Cloudera Manager versions generally support older API clients, using an outdated cm-client with a modern Cloudera Manager server might limit access to the latest platform capabilities.

Cloudera Manager Client Compatibility

The following table identifies the supported Python environments and the minimum Cloudera Manager version required for each cm-client release.
cm-client Version Supported Python Versions Minimum Cloudera Manager / Runtime Versions Supported
58.0.2 3.11 7.13.2 / 7.3.2.0

REST API Version Support

This table maps the REST API endpoint versions to the minimum Cloudera Manager version required to host them.
REST API Version Minimum Cloudera Manager Version Supported
v58 7.13.2.0
v57 7.13.1.0
v54 7.11.3.0