API Basics
Resources, authentication, operations, HTTP headers, and response codes for the Nirmata platform API.
Platform API
Reference for the Nirmata model-based platform API at /{service}/api.
The platform API is a model-based REST API that covers the objects managed by Nirmata Control Hub, such as clusters,
environments, applications, and policy data. Every service exposes its models under /{service}/api, and all
resources share the same conventions for querying, filtering, and navigating relationships.
This API is not versioned. See API Compatibility for details. For policy reports, exceptions, and compliance, use the versioned Policies API v1.
| Page | What it covers |
|---|---|
| API Basics | Resource model, authentication, operations, HTTP headers, and response codes |
| URL Parameters | fields, filter, sort, pagination, and other query parameters |
| Common Endpoints | descendants, ancestors, counts, and other endpoints on every resource |
| Resource Paths | Identifying resources by path instead of UUID |
| Sample Operations | Example requests for common tasks |
URL Parameters
Query parameters that control the JSON returned by the Nirmata platform API.
Common Endpoints
Endpoints that every resource in the Nirmata platform API implements.
Sample Operations
Example requests for common tasks with the Nirmata platform API.