Cluster Management API

NetApp Instaclustr offers the Cluster Management API to streamline the provisioning and management of clusters within the Instaclustr managed platform. The API serves as an alternative to the graphical Instaclustr Console or the infrastructure-as-code Terraform provider. With the Cluster Management API, you receive access to endpoints that can facilitate the creation, configuration and backing up of your clusters, all through a RESTful interface. 

The Cluster Management API supersedes the old Provisioning API, whose endpoints have now been deprecated. 

For comprehensive details on all API capabilities, please refer to our official Cluster Management API documentation. 

Table of Contents

Availability

Our APIs are engineered and operated for high levels of availability. However, you should not expect that our APIs have the same level of availability as a managed cluster, and you should not build any dependency on the APIs into availability of your service. While we do not provide formal SLAs for the APIs, we aim for 99.95% availability (i.e. up to approximately 20 mins downtime per month). Longer maintenance outages may be scheduled with appropriate notice. Consequently, any service dependent on the APIs should be able to cope gracefully with periods of unavailability of up to a few minutes. Planned and unplanned outages are communicated via our Status Page.

Authentication

To use the Cluster Management API, you will need an Instaclustr account and the necessary API keys. The Cluster Management API requires the use of either the Provisioning API key, or the Read Only Provisioning API key. The Read Only Provisioning API key only allows users to perform GET requests, whereas the requests using the Provisioning API key has full access to all Cluster Management API endpoints.

To add an API key to your account, please refer to our API Key documentation. 

API Documentation

For comprehensive details on the capabilities of the Cluster Management API, please refer to our official Cluster Management API documentation. This documentation provides all the information you will need on our API endpoints and also provides many examples. 

Request Samples 

In the API Documentation, to the right of each API endpoint, there is the Request Samples section. These can be easily copied to use in your queries for that endpoint. The samples are provided for curl (for use in your command line terminal), as well as for integration into a variety of popular programming languages. 

POST and PUT requests will typically require a payload to be sent as part of the request so that you can provide and change details and settings. For these cases, a Payload tab is added to the Request Samples section to provide easier viewing of the settings and the payload’s structure by utilizing collapsable sections. 

Many of the settings included in the payload sample are optional. To tell which settings are required you can view the Request Body Schema section of the documentation page for that endpoint. All the settings that are marked “required” must be included in the payload for the request to successfully run. 

Updating a Cluster

When using an endpoint to Update Cluster Details provide the payload with details on what you would like the cluster to look like. For example, if your cluster has 3 nodes, and you would like to double the size of your cluster to 6 nodes, then set the numberOfNodes setting to be 6.  

Rate Limits

To ensure fair usage and system stability, we enforce rate limits. For more information on API rate limits, please refer to the Rate Limits section of our Cluster Management API documentation.

Please contact Instaclustr Support if you need assistance.