REST API
The StorONE system provides a REST API to manage the system. All actions that can be performed using the CLI are available in the API.
You can access the interactive API documentation (built with Swagger) by navigating in your browser to the name or IP address of a StorONE controller node, and then clicking the REST API Interactive Guide link.
Using the Swagger UI, you can view and test API calls.
API requests require an authorization token. This section includes instructions for obtaining the token and making API calls using Python, Windows Powershell, and the cURL utility.
The examples demonstrate obtaining the token and using the token to list volumes using the endpoint. For a complete list of endpoints and the expected parameters and outputs, see the API reference guide.
Examples
API reference Guide
This section documents API endpoints and examples.
Login
Authentication API Key (Token) Parameter Name: Authorization, in: header. Authorization header ...
Applications
post__applications_create Code samples POST /applications/create HTTP/1.1 Content-Type: applic...
Configurations
get__configurations_list Code samples GET /configurations/list HTTP/1.1 Accept: application/js...
Floatingips
post__floatingips_create Code samples POST /floatingips/create HTTP/1.1 Content-Type: applicat...
Hosts
post__hosts_create Code samples POST /hosts/create HTTP/1.1 Content-Type: application/json-pat...
Monitoring
get__monitoring_alua_live Code samples GET /monitoring/alua/live HTTP/1.1 Accept: application/...
Nas_servers
post__nas_servers_create Code samples POST /nas_servers/create HTTP/1.1 Content-Type: applicat...
Nodes
put__nodes_chap Code samples PUT /nodes/chap HTTP/1.1 Content-Type: application/json-patch+jso...
Notifications
get__notifications_query Code samples GET /notifications/query HTTP/1.1 Accept: application/js...
Replication
put__replication_edit Code samples PUT /replication/edit HTTP/1.1 Content-Type: application/js...
Resources
delete__resources_delete Code samples DELETE /resources/delete HTTP/1.1 Accept: application/js...
Settings
put__settings_authentication Code samples PUT /settings/authentication HTTP/1.1 Content-Type: ...
Systems
get__systems_list Code samples GET /systems/list HTTP/1.1 Accept: application/json GET /syst...
Templates
post__templates_create Code samples POST /templates/create HTTP/1.1 Content-Type: application/...
Users
post__users_create Code samples POST /users/create HTTP/1.1 Content-Type: application/json-pat...
Version
get__Version Code samples GET /Version HTTP/1.1 Accept: application/json GET /Version See S1...
Workflows
get__workflows_volume_provisioning Code samples GET /workflows/volume_provisioning HTTP/1.1 Ac...
Vcp
post__vmware_datastore_vcp_create Code samples POST /vmware/datastore/vcp/create HTTP/1.1 Cont...
Schemas
AnomalyDetectionSettingsResult { "TimeframeDays": 0, "AbnormalChangePercentage": 0.1 } ...