API Compatibility
How Nirmata Control Hub REST APIs are versioned and what changes to expect within a version.
REST API
User Documentation for the Nirmata REST API
Applies to: Nirmata Control Hub 4.0 and later
Nirmata provides a REST API for easy integrations using any language of your choice. The API provides support for all operations that can be performed from the Nirmata Web Console or Command Line Tools.
Which API should I use?
| API | Base path | Use it for |
|---|---|---|
| Policies API v1 | /policies/api/v1 | Policy reports, policy exceptions, and compliance. Versioned and stable. |
| Platform API | /{service}/api | Clusters, environments, applications, and other platform objects. Not versioned. |
See API Compatibility for how each API is versioned.
Platform API
Reference for the Nirmata model-based platform API at /{service}/api.
Policies API v1
REST reference for the Policies service v1 API: policy reports, policy exceptions, and compliance.