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 Aggregates API

Operations for managing storage aggregates (local tiers)

NetApp Aggregates 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 Aggregates. 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 6 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 6 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 Aggregates 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.

Aggregates 5

Operations for managing storage aggregates (local tiers)

GET
/storage/aggregates
Netapp List Storage Aggregates
listAggregates 8 params → 200default
POST
/storage/aggregates
Netapp Create a New Aggregate
createAggregate body → 201202default
GET
/storage/aggregates/{uuid}
Netapp Retrieve a Specific Aggregate
getAggregate 2 params → 200default
PATCH
/storage/aggregates/{uuid}
Netapp Update an Aggregate
updateAggregate 1 param body → 200202default
DELETE
/storage/aggregates/{uuid}
Netapp Delete an Aggregate
deleteAggregate 1 param → 200202default

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Aggregate (10 properties), ClusterNodeReference (3 properties), JobLink (2 properties), CollectionLinks (2 properties). Each schema is shown below with its type and property counts.

CollectionLinks
object
Pagination links for collection responses
2 properties
Aggregate
object
An aggregate (local tier) is a collection of physical disks that provides a pool of storage from which FlexVol volumes are provisioned.
10 properties
SelfLink
object
HAL self link
1 property
JobLink
object
Reference to an asynchronous job
2 properties
ClusterNodeReference
object
Reference to a cluster node
3 properties
ErrorResponse
object
ONTAP REST API error response
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netapp-aggregates-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