---
title: "Reference"
description: "API reference and compatibility information for the Nirmata platform."
diataxis: reference
applies_to:
  product: "nirmata-control-hub"
audience: ["platform-engineer"]
last_updated: 2026-04-16
url: https://docs.nirmata.io/docs/reference/
---


Reference documentation for the Nirmata platform.

## Sections

- [REST API]({{< relref "rest-api/" >}}) — Full REST API documentation for Nirmata Control Hub
- [Compatibility Matrix]({{< relref "compatibility/" >}}) — Compatibility information for Nirmata Enterprise for Kyverno
- [Licensing]({{< relref "licensing/" >}}) — License terms for Nirmata products and the Policy Library


---

## Compatibility


The following table lists Enterprise Kyverno compatibility with various upstream Kubernetes versions.

> NOTE: The upstream release date corresponds to the release date of the dot one (.1) release of a given minor version.

| Kyverno Version | Upstream Release | Nirmata Enterprise Release | Enterprise Kyverno Version | Kubernetes Versions | Nirmata Enterprise End of Support |
| --------------- | --------------- | ------------------------- | ------------------------- | ------------------ | -------------------------------- |
| 1.17 | February 19, 2026 | February 19, 2026 | v1.17.0-n4k.nirmata.1 | 1.32 - 1.35 | August 19, 2027 |
| 1.16 | November 10, 2025 | November 10, 2025 | v1.16.1-n4k.nirmata.4 | 1.31 - 1.35 | July 10, 2027 |
| 1.15 | July 31, 2025 | September 2, 2025 | v1.15.2-n4k.nirmata.1 | 1.30 - 1.35 | April 2, 2027 |
| 1.14 | June 19, 2025 | June 27, 2025 | v1.14.4-n4k.nirmata.1 | 1.28 - 1.35 | Jan 25, 2027 |
| 1.13 | October 29, 2024 | December 26, 2024 | v1.13.6-n4k.nirmata.10 | 1.28 - 1.35 | August 25, 2026 |

> NOTE: To get more information on Enterprise Support for your distribution and version of Kubernetes, please contact [Nirmata Support](mailto:support@nirmata.com).

> NOTE: Support for older Kubernetes versions will be dropped along with the End of Support for a given cloud provider.

> NOTE: Due to a known issue with Kubernetes 1.23.0-1.23.2, support for 1.23 begins at 1.23.3.


---

## Licensing


This page summarizes the license terms that apply to Nirmata products and the open-source policy library.

## Nirmata Enterprise for Kyverno

**Nirmata Enterprise for Kyverno** is commercial software, available under a paid subscription from Nirmata Inc. It is not open-source.

- Provides enterprise-grade distribution of [Kyverno](https://kyverno.io) with long-term support (LTS), security patches, and SLAs
- Use is governed by the [Nirmata Terms of Use](https://nirmata.com/terms-of-use/)
- Requires a valid Nirmata subscription — [contact Nirmata](https://nirmata.com/request-a-demo/) to get access

> **Note:** [Kyverno](https://kyverno.io) itself is an open-source project, licensed under **Apache 2.0**, maintained as a CNCF Graduated project. You can use Kyverno directly without a Nirmata subscription. Nirmata Enterprise for Kyverno is a separately licensed commercial product built on top of Kyverno.

## Nirmata Control Hub

**Nirmata Control Hub** is commercial software, available under a paid subscription from Nirmata Inc.

- Use is governed by the [Nirmata Terms of Use](https://nirmata.com/terms-of-use/)
- Requires a valid Nirmata subscription — [contact Nirmata](https://nirmata.com/request-a-demo/) to get access

## Policy Library (`kyverno-policies`)

The [Nirmata Policy Library](https://github.com/nirmata/kyverno-policies) — the collection of curated Kyverno policies available at `github.com/nirmata/kyverno-policies` — is licensed under the **GNU Affero General Public License v3.0 (AGPL-3.0)**.

Key implications of AGPL-3.0:

- **Source must remain open**: Any modified version of the policies must also be made available under AGPL-3.0
- **Network use clause**: If you deploy a modified version as a network service, you must make the source code available to users of that service
- **Attribution required**: Copyright and license notices must be retained

See the [full license text](https://github.com/nirmata/kyverno-policies/blob/main/LICENSE) for complete terms.

> If your use case requires different license terms — for example, using the policies in a proprietary product — [contact Nirmata](https://nirmata.com/request-a-demo/) to discuss commercial licensing options.

## Nirmata Terraform Controller

**Nirmata Terraform Controller** is commercial software, available under a paid subscription from Nirmata Inc.

- Use is governed by the [Nirmata Terms of Use](https://nirmata.com/terms-of-use/)
- Requires a valid Nirmata subscription — [contact Nirmata](https://nirmata.com/request-a-demo/) to get access

## Summary

| Product | License | Notes |
|---|---|---|
| Nirmata Enterprise for Kyverno | Commercial | Subscription required; governed by [Terms of Use](https://nirmata.com/terms-of-use/) |
| Nirmata Control Hub | Commercial | Subscription required; governed by [Terms of Use](https://nirmata.com/terms-of-use/) |
| Nirmata Terraform Controller | Commercial | Subscription required; governed by [Terms of Use](https://nirmata.com/terms-of-use/) |
| Nirmata Policy Library (`kyverno-policies`) | AGPL-3.0 | Open-source with copyleft and network-use requirements |
| Kyverno (upstream) | Apache 2.0 | CNCF Graduated open-source project |

## Questions

For licensing questions, [contact Nirmata](https://nirmata.com/request-a-demo/) or review the [Terms of Use](https://nirmata.com/terms-of-use/).


---

## 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. 

 

