IN THIS ARTICLE
Outlines how to get started with the the Qumulo Core REST API on QF2 clusters
- Cluster running Qumulo Core
- Command line (CLI) tools installed via API & Tools tab
- Python client library wrappers
What is the Qumulo REST API?
On your cluster is a dashboard application that shows cluster analytics, lets you define shares, provides links to support. There is also a link to ‘API and Tools’ which lets you download the python client library wrappers and CLI for the Qumulo Core REST API and also provides direct navigable “live” documentation where you can read about the different APIs and experiment by trying things out directly in place.
Qumulo API Concepts
The Qumulo REST API covers cluster concepts including authentication, cluster and node state, cluster analytics, files and resources, sharing/permissions and more. On your cluster, navigate to the cluster hostname followed by /api to view the documentation for the REST API. You can also try out the code live on this page!
Getting the Qumulo REST API
There are several ways to obtain the python client wrapper and CLI for Qumulo Core REST API:
- On your cluster, click the APIs & Tools button and then click Download Command-Line Tools
- Sign up for a Qumulo virtual machine/ virtual cluster and download as in (1) above
- Create a python application and add a reference to the public Qumulo REST API python library in your application requirements.txt file, like this
If you do not specify a version number, you will get the latest version of the library.
You can find sample code for the Qumulo REST API on GitHub along with a starter template to begin creating your own projects.
To give you a taste of what you can do with the Qumulo REST API, here are some example calls and the result (this example is using our provided RestClient wrapper class -- you can run these and more samples yourself using the example here):
api_cli = RestClient(cluster, 8000)
You should now successfully be able to begin working and utilizing the Qumulo Core API
Like what you see? Share this article with your network!