NetApp ActiveIQ API Documentation¶

Overview¶

NetApp ActiveIQ provides a robust REST API suite through Active IQ Unified Manager and Digital Advisor to programmatically manage, monitor, and extract data from NetApp storage environments.

Key Features¶

• 100+ API endpoints across 20+ service categories
• RESTful design with full CRUD operations
• JSON-based request/response format
• HTTP Basic Authentication
• Comprehensive coverage of storage operations

Documentation Structure¶

📖 API Overview¶

General introduction to the NetApp ActiveIQ API, including: - API capabilities and features - Authentication and access requirements - Getting started guide - Common use cases

🔗 API Endpoints Reference¶

Complete reference of available API endpoints: - Administration endpoints - Datacenter management - Storage provider operations - Management server functions - Gateway APIs

📊 Data Models¶

Detailed documentation of API data structures: - Core data models - Performance metrics - Event management objects - Storage and cluster information - Request/response formats

💻 Examples and Use Cases¶

Practical examples and automation scripts: - Infrastructure discovery - Storage monitoring - Performance tracking - Event management - Backup automation - Health check scripts

🚀 Advanced Use Cases¶

Advanced workflows with sequence diagrams: - SVM creation automation - NFS share management - Credential updates and security - Complete environment deployment - Sequence diagrams for complex workflows - Production-ready automation scripts

Quick Start¶

1. Access Requirements¶

To use the ActiveIQ API, you need: - Active IQ Unified Manager instance - User account with appropriate role: - Operator - Storage Administrator - Application Administrator

2. Base URL¶

https://<your-unified-manager-host>/api/v2

3. Authentication¶

All API calls use HTTP Basic Authentication:

curl -u "username:password" -X GET "https://<host>/api/v2/datacenter/cluster/clusters"

4. Interactive Documentation¶

Access the Swagger UI for live API testing:

https://<your-unified-manager-host>/apidocs/

Common Operations¶

Get Cluster Information¶

GET /api/v2/datacenter/cluster/clusters

Monitor Storage Capacity¶

GET /api/v2/datacenter/storage/volumes?fields=name,size,svm,cluster

Check Critical Events¶

GET /api/v2/management-server/events?query=severity:critical

Create Backup¶

POST /api/v2/admin/backup

Data Sources¶

This documentation is derived from analysis of: - NetApp ActiveIQ API research documents - OpenAPI specification (16,674 lines) - Official NetApp documentation references - Practical implementation examples

External Resources¶

• Official NetApp ActiveIQ Documentation
• Active IQ Unified Manager API Guide
• Digital Advisor API Services

Last updated: Based on analysis of external data sources in donnees-externes/ folder