Skip to main content

REST API

REST API overview

The StorONE REST API lets you do over HTTPS what you do in the web interface and the CLI: provisi...

Authentication

You authenticate to the REST API with the same StorONE user accounts you use for the web interfac...

Requests and responses

Every endpoint follows the same conventions, so once you've made one call you know how to make th...

Asynchronous operations

By default, a create, edit, or delete request waits for the operation to finish and returns the o...

Examples

Each example below does the same thing, so you can pick the language you work in: Log in and get ...

Endpoint Reference

REST endpoints: Action policies

These endpoints mirror the CLI commands described in Action Policies, Pending Actions. Each endpo...

REST endpoints: Applications and volumes

These endpoints mirror the CLI commands described in Applications, Volumes. Each endpoint runs th...

REST endpoints: Audit, logs, and version

These endpoints mirror the CLI commands described in the matching CLI chapters. Each endpoint run...

REST endpoints: Automation

These endpoints mirror the CLI commands described in Automation. Each endpoint runs the CLI comma...

REST endpoints: Configurations and settings

These endpoints mirror the CLI commands described in Configurations, Settings, Anomaly Detection....

REST endpoints: Encryption

These endpoints mirror the CLI commands described in Encryption. Each endpoint runs the CLI comma...

REST endpoints: File systems, shares, and mappings

These endpoints mirror the CLI commands described in File systems, Mappings, Shares. Each endpoin...

REST endpoints: Floating IPs

These endpoints mirror the CLI commands described in Floating IPs, Pairing floating IPs for repli...

REST endpoints: Hosts

These endpoints mirror the CLI commands described in Hosts, Host groups and pairing. Each endpoin...

REST endpoints: Monitoring

These endpoints mirror the CLI commands described in Health and capacity, Historical monitoring, ...

REST endpoints: NAS servers

These endpoints mirror the CLI commands described in NAS servers, Local admins. Each endpoint run...

REST endpoints: Nodes

These endpoints mirror the CLI commands described in Nodes overview, High availability, Support a...

REST endpoints: Notifications and history

These endpoints mirror the CLI commands described in Notifications, Browsing notification history...

REST endpoints: Notification targets

These endpoints mirror the CLI commands described in Notifications. Each endpoint runs the CLI co...

REST endpoints: Object stores and access keys

These endpoints mirror the CLI commands described in Object stores, Access keys. Each endpoint ru...

REST endpoints: Replication

These endpoints mirror the CLI commands described in Replication, Replication IPs, Starting and s...

REST endpoints: Resources: drives and pools

These endpoints mirror the CLI commands described in Resources overview, Drives, Pools. Each endp...

REST endpoints: Resources: network

These endpoints mirror the CLI commands described in Network. Each endpoint runs the CLI command ...

REST endpoints: Scheduled reports

These endpoints mirror the CLI commands described in Scheduled reports. Each endpoint runs the CL...

REST endpoints: Snapshots

These endpoints mirror the CLI commands described in Snapshots, File recovery. Each endpoint runs...

REST endpoints: Software updates and license

These endpoints mirror the CLI commands described in Software updates, License. Each endpoint run...

REST endpoints: Systems

These endpoints mirror the CLI commands described in Systems. Each endpoint runs the CLI command ...

REST endpoints: Tiering

These endpoints mirror the CLI commands described in Tiering. Each endpoint runs the CLI command ...

REST endpoints: Users and permissions

These endpoints mirror the CLI commands described in Users, Permission policies. Each endpoint ru...