Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NetApp Volumes API

Operations for creating, modifying, and managing storage volumes

NetApp Volumes API is one of 18 APIs that NetApp publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Volumes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, an API reference, release notes, and 1 JSON Schema.

This API exposes 5 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.1.0, at version 9.15.1.

Requests are made against a single base URL, https://{clusterMgmtIp}/api.

5 operations 2 paths 8 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
9.15.1
Base URL
https://cloudmanager.cloud.netapp.com
Authentication
HTTP Basic, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

NetApp Volumes API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • basicAuth — HTTP basic authentication using ONTAP user credentials. Provide the cluster or SVM administrator username and password.
  • bearerAuth — OAuth 2.0 bearer token authentication. Supported in ONTAP 9.8 and later.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Volumes 5

Operations for creating, modifying, and managing storage volumes

GET
/storage/volumes
Netapp List Storage Volumes
listVolumes 9 params → 200default
POST
/storage/volumes
Netapp Create a New Volume
createVolume 1 param body → 201202default
GET
/storage/volumes/{uuid}
Netapp Retrieve a Specific Volume
getVolume 2 params → 200default
PATCH
/storage/volumes/{uuid}
Netapp Update a Volume
updateVolume 1 param body → 200202default
DELETE
/storage/volumes/{uuid}
Netapp Delete a Volume
deleteVolume 1 param → 200202default

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Volume (21 properties), VolumeReference (3 properties), SvmReference (3 properties), AggregateReference (3 properties). Each schema is shown below with its type and property counts.

CollectionLinks
object
Pagination links for collection responses
2 properties
Volume
object
A storage volume is a logical container for data. Volumes are created within SVMs and reside on aggregates. They provide the primary unit of data management in…
21 properties
AggregateReference
object
Reference to an aggregate
3 properties
SvmReference
object
Reference to an SVM
3 properties
SelfLink
object
HAL self link
1 property
JobLink
object
Reference to an asynchronous job
2 properties
VolumeReference
object
Reference to a volume
3 properties
ErrorResponse
object
ONTAP REST API error response
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netapp-volumes-api-openapi.yml Raw ↑

Other APIs NetApp publishes across the network.

NetApp Cloud Volumes Service API
NetApp Astra Control API
NetApp StorageGRID API
NetApp Element API
NetApp Cloud Insights API
NetApp BlueXP Automation API
NetApp Active IQ Unified Manager API
NetApp Active IQ Digital Advisor API
NetApp SnapCenter API
NetApp E-Series SANtricity Web Services API
Azure NetApp Files REST API
NetApp ONTAP Tools for VMware vSphere API