Nutanix Legacy API Deprecation NoteWe will be announcing the deprecation and removal plan for legacy API versions v0.8, v1, v2 and v3 ,with the exact timeline to be determined. You will be given sufficient time to migrate away from the legacy API versions before we deprecate them. However, we recommend you start evaluating and planning the migration to the new v4 APIs and SDKs.
Nutanix v4 APIs
Welcome! We are pleased to launch the Release Candidate (RC) and Early Access (EA) program for our version 4 (v4) family of Nutanix Prism APIs.
What is it and why is it important?
Nutanix APIs have grown over the past decade and now provide support for multiple endpoints, clusters, products, and operations. Our goal with the version 4 REST APIs is to provide a comprehensive and consistent set of APIs for operating the Nutanix Cloud Platform. v4 API has semantics based on open standards, delivering enhanced usability and developer experience.
Today, Nutanix offers four different versions of APIs. We provide diverse API support through these individual versions, and you might require a combination of these versions to address your needs. v4 APIs will consolidate all our APIs into a single platform API. v4 API is being developed with an “API first” mentality where API documentation and supporting SDKs are published concurrently with each product version update.
What's new in v4?
Our new v4 API family delivers a whole host of new functionality for Nutanix API users. Some of the top new features include:
- For developers/API consumers
- SDK Support across Python, Go lang, Java and JS.
- A new developer portal with a comprehensive set of API, SDK documentation, and code samples.
- Enhanced usability, filtering, sorting, and selection through OData.
- API versioning.
- API compatibility with and starting from the v4 RC release. EA versions of v4 API are not guaranteed to be backward compatible.
Related Documentation
The first set of Nutanix v4 API and SDK documentation is now live and can be accessed below. If you are an existing user of our v2.0 or v3 APIs you may wish to start with the v4 API Migration Guide.
Note: The code sample library will be expanded as new APIs are released.
- v4 API User Guide
- v4 API Migration Guide
- v4 API Documentation
- Nutanix v4 API Versioning Scheme
- All API References
- Code Sample Library
- Semantic Versioning 2.0.0
Which APIs are included in this release?
The Early Access (“EA”) and Release Candidate (“RC”) v4 API releases represent the next step for cloud consumption, integration, and automation of the Nutanix Cloud Platform. The launch publishes the following APIs in Prism Central.
| API Namespace | Namespace Endpoint | Status | Prism Central version | AOS version |
|---|---|---|---|---|
| AI Ops | aiops | EA | pc.2022.6 or later | 6.5 |
| Cluster Management | clustermgmt | RC | pc.2023.3 or later | 6.7 |
| Files | files | EA | pc.2022.6 or later | 6.5 |
| Identity and Access Management (IAM) | iam | RC | pc.2023.3 or later | 6.7 |
| Lifecycle Management (LCM) | lifecycle | RC | pc.2024.1 or later | 6.8 + LCM 3.0 |
| Networking | networking | RC | pc.2023.3 or later | 6.7 |
| Prism (Categories, Tasks) | prism | RC | pc.2024.1 or later | 6.8 |
| Virtual Machine Management | vmm | RC | pc.2024.1 or later | 6.8 |
| Data Protection | dataprotection | RC | pc.2024.1 or later | 6.8 |
| Flow Management | microseg | RC | pc.2024.1 or later | 6.8 |
| Monitoring | monitoring | RC | pc.2024.1 or later | 6.8 |
| Volumes | volumes | RC | pc.2024.1 or later | 6.8 |
| Licensing | licensing | EA | pc.2024.1 or later | 6.8 |
| Objects Storage Management | objects | EA | pc.2024.1 or later | 6.8 |
Use of v4 APIs in a Prism Element or Prism Central environment that does not meet the version requirements above may cause the request(s) to fail.
Subsequent releases of Prism Central will expose additional v4 APIs with each version. The following are the APIs in pipeline and will be released in future versions.
- Prism Central Management
- NCC
- Disaster Recovery
- Security APIs
- Foundation Central
- Nutanix Cloud Manager (NCM) including Self Service
- NDB (formerly Era)
- NKE (formerly Karbon)
Frequently Asked Questions
- What is the v4 API Early Access ( EA) program?
- This program provides a way of using the new v4 APIs while they are under active development. The feedback collected from these v4 API consumers will be used to optimize the implementation of v4 APIs before being made generally available (GA).
- How do Release Candidate (RC) v4 APIs differ from EA v4 APIs?
- RC APIs have been tested to be backward compatible across all API revisions within the v4 family, except EA versions. EA v4 APIs do not guarantee backward compatibility and may include unknown issues. For more information, refer to Nutanix v4 API Versioning Scheme.
- Do I need user permissions or licenses to access the v4 EA or RC APIs?
- v4 API consumers do not require any registration or license to participate in this program. For more information, refer to our “Related documentation” section to get started immediately!
- Can I use v4 EA or RC APIs in a production environment?
- No, EA or RC v4 APIs are not supported in production environments.
- Will I receive support for the v4 EA or RC APIs?
- The Nutanix support communities handle support for v4 EA and RC APIs. If you need support or have questions, refer to the “How It Works” section of the Nutanix communities..
- What is the release timeline for v4 API general availability (GA)?
- The GA version of the v4 APIs will be rolled out in phases. The first set of v4 APIs will be generally available in CY24.
